Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a bunch of typos in core and include files #66

Merged
merged 1 commit into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/mender-api.c
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ mender_api_websocket_callback(mender_websocket_client_event_t event, void *data,
mender_log_info("Troubleshoot client disconnected");
break;
case MENDER_WEBSOCKET_EVENT_ERROR:
/* Websocket conection fails */
/* Websocket connection fails */
mender_log_error("An error occurred");
ret = MENDER_FAIL;
break;
Expand Down
28 changes: 14 additions & 14 deletions core/src/mender-artifact.c
Original file line number Diff line number Diff line change
Expand Up @@ -64,43 +64,43 @@ typedef struct {
/**
* @brief Parse header of TAR file
* @param ctx Artifact context
* @return MENDER_DONE if the data have been parsed, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_parse_tar_header(mender_artifact_ctx_t *ctx);

/**
* @brief Check version file of the artifact
* @param ctx Artifact context
* @return MENDER_DONE if the data have been parsed and version verified, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed and version verified, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_check_version(mender_artifact_ctx_t *ctx);

/**
* @brief Read header-info file of the artifact
* @param ctx Artifact context
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_read_header_info(mender_artifact_ctx_t *ctx);

/**
* @brief Read meta-data file of the artifact
* @param ctx Artifact context
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_read_meta_data(mender_artifact_ctx_t *ctx);

/**
* @brief Read data file of the artifact
* @param ctx Artifact context
* @param callback Callback function to be invoked to perform the treatment of the data from the artifact
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed and payloads retrieved, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_read_data(mender_artifact_ctx_t *ctx, mender_err_t (*callback)(char *, cJSON *, char *, size_t, void *, size_t, size_t));

/**
* @brief Drop content of the current file of the artifact
* @param ctx Artifact context
* @return MENDER_DONE if the data have been parsed and dropped, MENDER_OK if there is not enougth data to parse, error code if an error occured
* @return MENDER_DONE if the data have been parsed and dropped, MENDER_OK if there is not enough data to parse, error code if an error occurred
*/
static mender_err_t mender_artifact_drop_file(mender_artifact_ctx_t *ctx);

Expand All @@ -113,7 +113,7 @@ static mender_err_t mender_artifact_drop_file(mender_artifact_ctx_t *ctx);
static mender_err_t mender_artifact_shift_data(mender_artifact_ctx_t *ctx, size_t length);

/**
* @brief Compute length rounded up to increment (usualy the block size)
* @brief Compute length rounded up to increment (usually the block size)
* @param length Length
* @param incr Increment
* @return Rounded length
Expand Down Expand Up @@ -255,7 +255,7 @@ mender_artifact_parse_tar_header(mender_artifact_ctx_t *ctx) {
assert(NULL != ctx);
char *tmp;

/* Check if enought data are received (at least one block) */
/* Check if enough data are received (at least one block) */
if ((NULL == ctx->input.data) || (ctx->input.length < MENDER_ARTIFACT_STREAM_BLOCK_SIZE)) {
return MENDER_OK;
}
Expand All @@ -266,7 +266,7 @@ mender_artifact_parse_tar_header(mender_artifact_ctx_t *ctx) {
/* Check if file name is provided, else the end of the current TAR file is reached */
if ('\0' == tar_header->name[0]) {

/* Check if enought data are received (at least 2 blocks) */
/* Check if enough data are received (at least 2 blocks) */
if (ctx->input.length < 2 * MENDER_ARTIFACT_STREAM_BLOCK_SIZE) {
return MENDER_OK;
}
Expand Down Expand Up @@ -533,9 +533,9 @@ mender_artifact_read_data(mender_artifact_ctx_t *ctx, mender_err_t (*callback)(c
/* Check if a file name is provided (we don't check the extension because we don't know it) */
if (strlen("data/xxxx.tar") == strlen(ctx->file.name)) {

/* Begining of the data file */
/* Beginning of the data file */
if (MENDER_OK != (ret = callback(ctx->payloads.values[index].type, ctx->payloads.values[index].meta_data, NULL, 0, NULL, 0, 0))) {
mender_log_error("An error occured");
mender_log_error("An error occurred");
return ret;
}

Expand All @@ -551,7 +551,7 @@ mender_artifact_read_data(mender_artifact_ctx_t *ctx, mender_err_t (*callback)(c
/* Parse data until the end of the file has been reached */
do {

/* Check if enought data are received (at least one block) */
/* Check if enough data are received (at least one block) */
if ((NULL == ctx->input.data) || (ctx->input.length < MENDER_ARTIFACT_STREAM_BLOCK_SIZE)) {
return MENDER_OK;
}
Expand All @@ -569,7 +569,7 @@ mender_artifact_read_data(mender_artifact_ctx_t *ctx, mender_err_t (*callback)(c
ctx->input.data,
ctx->file.index,
length))) {
mender_log_error("An error occured");
mender_log_error("An error occurred");
return ret;
}

Expand Down Expand Up @@ -602,7 +602,7 @@ mender_artifact_drop_file(mender_artifact_ctx_t *ctx) {
/* Parse data until the end of the file has been reached */
do {

/* Check if enought data are received (at least one block) */
/* Check if enough data are received (at least one block) */
if ((NULL == ctx->input.data) || (ctx->input.length < MENDER_ARTIFACT_STREAM_BLOCK_SIZE)) {
return MENDER_OK;
}
Expand Down
4 changes: 2 additions & 2 deletions core/src/mender-client.c
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ static mender_err_t mender_client_update_work_function(void);
* @param data Artifact data
* @param index Artifact data index
* @param length Artifact data length
* @return MENDER_OK if the function succeeds, error code if an error occured
* @return MENDER_OK if the function succeeds, error code if an error occurred
*/
static mender_err_t mender_client_download_artifact_callback(
char *type, cJSON *meta_data, char *filename, size_t size, void *data, size_t index, size_t length);
Expand All @@ -192,7 +192,7 @@ static mender_err_t mender_client_download_artifact_callback(
* @param data Artifact data
* @param index Artifact data index
* @param length Artifact data length
* @return MENDER_OK if the function succeeds, error code if an error occured
* @return MENDER_OK if the function succeeds, error code if an error occurred
*/
static mender_err_t mender_client_download_artifact_flash_callback(
char *id, char *artifact_name, char *type, cJSON *meta_data, char *filename, size_t size, void *data, size_t index, size_t length);
Expand Down
2 changes: 1 addition & 1 deletion core/src/mender-utils.c
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ mender_utils_strbeginwith(const char *s1, const char *s2) {
return false;
}

/* Compare the begining of the string */
/* Compare the beginning of the string */
return (0 == strncmp(s1, s2, strlen(s2)));
}

Expand Down
4 changes: 2 additions & 2 deletions include/mender-tls.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ mender_err_t mender_tls_init(void);

/**
* @brief Initialize mender TLS authentication keys
* @param recommissioning perform recommisioning (if supported by the platform)
* @param recommissioning Perform recommissioning (if supported by the platform)
* @return MENDER_OK if the function succeeds, error code otherwise
*/
mender_err_t mender_tls_init_authentication_keys(bool recommissioning);

/**
* @brief Get public key (PEM format suitable to be integrated in mender authentication request)
* @param public_key Public key, NULL if an error occured
* @param public_key Public key, NULL if an error occurred
* @return MENDER_OK if the function succeeds, error code otherwise
*/
mender_err_t mender_tls_get_public_key_pem(char **public_key);
Expand Down
Loading