From 80bb0c1ac4b8424540d9dadfc1132590ae002f06 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Mon, 5 Jan 2026 17:42:20 +0100 Subject: [PATCH] chore: fix typos Bump GitHub action workflows to their latest versions --- .github/workflows/upload_component.yml | 4 ++-- README.md | 12 ++++++------ docs/Doxyfile | 2 +- include/frogfs/frogfs.h | 4 ++-- src/frogfs.c | 2 +- src/frogfs_priv.h | 2 +- tools/mkfrogfs.py | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/upload_component.yml b/.github/workflows/upload_component.yml index 7e618ee..389312b 100644 --- a/.github/workflows/upload_component.yml +++ b/.github/workflows/upload_component.yml @@ -10,11 +10,11 @@ jobs: upload_components: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v6 with: submodules: recursive - name: Upload component to the registry - uses: espressif/upload-components-ci-action@v1 + uses: espressif/upload-components-ci-action@v2 with: namespace: "jkent" name: "frogfs" diff --git a/README.md b/README.md index 7c0f701..56f8763 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ To use this component with ESP-IDF, within your projects directory run ## Embedding a FrogFS image -Embed FrogFS within your project binary with the folowing CMake function: +Embed FrogFS within your project binary with the following CMake function: target_add_frogfs( [CONFIG yaml] [NAME name]) @@ -91,7 +91,7 @@ application. A CMake function is provided to output a binary with target declare_frogfs_bin(path [CONFIG yaml] [NAME name]) If **CONFIG** is not specified, `frogfs.yaml` is used. If **NAME** is not -specifed, `frogfs` is used. +specified, `frogfs` is used. Here's an example of what you can add to your toplevel CMakeLists.txt: @@ -125,7 +125,7 @@ that path are placed in the destination. Otherwise, the path itself is placed in the destination. The destination defaults to the root directory, or in the case of a dictionary key, a root relative path is used. -For exmple: +For example: ```yaml collect: @@ -141,7 +141,7 @@ Variables can be used on both source paths and destination paths. Filter allows you to do post-processing on the files before they are integrated. Filter is a list or dict of dicts; with a glob pattern to a list -of verbs. Varibales are expanded and all patterns are evaluated for each file +of verbs. Variables are expanded and all patterns are evaluated for each file or directory, top down. Transforms are applied first, then an optional final compression before caching the file. @@ -197,7 +197,7 @@ preventing you from mix and matching both at the same time, however. ### Shared initialization -Configuration requries defining a `frogfs_config_t` structure and passing it +Configuration requires defining a `frogfs_config_t` structure and passing it to `frogfs_init`. Two different ways to specify the filesystem: 1. a memory address using the `addr` variable: @@ -296,7 +296,7 @@ add your own transforms by creating a `tools` directory in your projects root directory, with a filename starting with `transform-` and ending with `.js` or `.py`. Transform tools take data on stdin and produce output on stdout. -Both transform and compresors can accept arguments. See `frogfs_example.yaml` +Both transform and compressors can accept arguments. See `frogfs_example.yaml` for an example. # History and Acknowledgements diff --git a/docs/Doxyfile b/docs/Doxyfile index 28cdbfc..9bb2bbb 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -16,7 +16,7 @@ PROJECT_NAME = "FrogFS Programming Guide" ## The 'INPUT' statement below is used as input by script 'gen-df-input.py' -## to automatically generate API reference list files heder_file.inc +## to automatically generate API reference list files header_file.inc ## These files are placed in '_inc' directory ## and used to include in API reference documentation diff --git a/include/frogfs/frogfs.h b/include/frogfs/frogfs.h index 45dd35a..b067676 100644 --- a/include/frogfs/frogfs.h +++ b/include/frogfs/frogfs.h @@ -174,7 +174,7 @@ void frogfs_stat(const frogfs_fs_t *fs, const frogfs_entry_t *entry, /** * \brief Open a frogfs entry as a file from a \a frogfs_fs_t instance - * \param[in] fs \a frogfs_fs_t poitner + * \param[in] fs \a frogfs_fs_t pointer * \param[in] entry \a frogfs_entry_t pointer * \param[in] flags open flags * \return \a frogfs_fh_t or \a NULL if not found @@ -230,7 +230,7 @@ size_t frogfs_tell(frogfs_fh_t *fh); size_t frogfs_access(frogfs_fh_t *fh, const void **buf); /** - * \brief Open a directory for reading child entrys + * \brief Open a directory for reading child entries * \param[in] fs \a frogfs_fs_t pointer * \param[in] entry \a frogfs_entry_t pointer to root director * \return \a frogfs_dh_t pointer or \a NULL if invalid diff --git a/src/frogfs.c b/src/frogfs.c index 43196f7..3ee05f7 100644 --- a/src/frogfs.c +++ b/src/frogfs.c @@ -186,7 +186,7 @@ const frogfs_entry_t *frogfs_get_entry(const frogfs_fs_t *fs, const char *path) middle--; } - /* walk through canidates and look for a match */ + /* walk through candidates and look for a match */ const frogfs_entry_t *entry; do { entry = (const void *) fs->head + e->offs; diff --git a/src/frogfs_priv.h b/src/frogfs_priv.h index 8450a9d..fddf6a4 100644 --- a/src/frogfs_priv.h +++ b/src/frogfs_priv.h @@ -26,7 +26,7 @@ typedef struct frogfs_fh_t { size_t data_sz; /**< data size */ size_t real_sz; /**< real (expanded) size */ unsigned int flags; /** open flags */ - const frogfs_decomp_funcs_t *decomp_funcs; /**< decompresor funcs */ + const frogfs_decomp_funcs_t *decomp_funcs; /**< decompressor funcs */ void *decomp_priv; /**< decompressor private data */ } frogfs_fh_t; diff --git a/tools/mkfrogfs.py b/tools/mkfrogfs.py index d193f5c..902ab5d 100755 --- a/tools/mkfrogfs.py +++ b/tools/mkfrogfs.py @@ -577,7 +577,7 @@ def generate_dir_header(dirent: dict) -> None: dirent['data_size'] = 0 def generate_entry_headers() -> None: - '''Iterate entries and call their respective generate header funciton''' + '''Iterate entries and call their respective generate header function''' for ent in entries.values(): if ent['type'] == 'file': generate_file_header(ent)