IMHO, we shouldn't set this option by default. That should be optional for users.

I agree with @ActoryOu here. this should be an active choice by users.

I don't think I agree. The CMakeList.txt creates a compiled library, so we need the config file when we compile the library. Then we would need to distribute the binary, lib headers and the custom header, and include it again with building the final app.

AFAIK there is no way to include a custom include file dynamically when building the library. If the user is building the app alongside with the library (i.e. including the custom config file before including the sigv4 header), then it should be using the sigv4FilePaths.cmake instead.

If you want to control the values of the default config, we could add cmake configuration variables for controlling the individual parameters:

• SIGV4_PROCESSING_BUFFER_LENGTH
• SIGV4_MAX_HTTP_HEADER_COUNT
• SIGV4_MAX_QUERY_PAIR_COUNT
• SIGV4_WORST_CASE_SORT_STACK_SIZE
• SIGV4_HASH_MAX_BLOCK_LENGTH
• SIGV4_HASH_MAX_DIGEST_LENGTH
• SIGV4_USE_CANONICAL_SUPPORT

Overriding logging should be better done as a method and not as a macro IMHO.

Could a middle ground here be to do what is done in the FreeRTOS-Kernel's CMakeLists.txt where the directory for the config file is checked?

A user that does not pass one in could then just be defaulted to having this option set?

seems good to me

I tried to provide a patch cloning the freertos kernel cmakelist.txt, not sure if this is what you expected. Could you review it, please?

Why was this change needed?

EDIT: Sorry, had missed the conversation above link

There is already precedent to add CMAKE variables to the lexicons. I consider this worth the tradeoff of having more basic typos caught with a single command than separate commands/config files.

Running it locally I got this result:

# spellCheck
(node:22730) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
 1/38 ./CHANGELOG.md 281.05ms
 2/38 ./CMakeLists.txt 99.14ms X
/Users/skptak/repos/libraries/SigV4-for-AWS-IoT-embedded-sdk/CMakeLists.txt:35:53     - Unknown word (DSIGV)      -- PROJECT_NAME} PRIVATE -DSIGV4_DO_NOT_USE_CUSTOM_CONFIG
	 Suggestions: [sigv, SIGV, SDIV, DSIZE, DESIGN]

I would much rather add DSIGV to the .cSpellWords.txt than to exclude this file from all spell checks.

I agree with @Skptak. We should not remove CMakeLists.txt since there are only few violations which we need to add to cSpellWords.txt.

seems fine for me, let me change it