Minor cleanup of examples

examples/basic/README.md

@@ -23,10 +23,7 @@ The configuration file [mlkem_native_config.h](mlkem_native/mlkem_native_config.
 - `MLK_CONFIG_PARAMETER_SET`: Security level (512, 768, or 1024). Default is 768.
 - `MLK_CONFIG_NAMESPACE_PREFIX`: Symbol prefix for the API. Set to `mlkem` in this example.
 
-To change the security level, modify `MLK_CONFIG_PARAMETER_SET` in the config file or pass it via CFLAGS:
-```bash
-make build CFLAGS="-DMLK_CONFIG_PARAMETER_SET=512"
-```
+To change the security level, modify `MLK_CONFIG_PARAMETER_SET` in the config file or pass it via CFLAGS.
 
 ## Usage
 

examples/basic/main.c

@@ -11,7 +11,6 @@
  * This requires specifying the parameter set and namespace prefix
  * used for the build.
  */
-#define MLK_CONFIG_NAMESPACE_PREFIX mlkem
 #include "mlkem_native/mlkem_native.h"
 
 #include "test_only_rng/notrandombytes.h"

examples/basic_deterministic/mlkem_native/mlkem_native_config.h

@@ -63,7 +63,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -76,7 +76,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/bring_your_own_fips202/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/bring_your_own_fips202/main.c

@@ -11,7 +11,6 @@
  * This requires specifying the parameter set and namespace prefix
  * used for the build.
  */
-#define MLK_CONFIG_NAMESPACE_PREFIX mlkem
 #include <mlkem_native.h>
 
 #include "test_only_rng/notrandombytes.h"

examples/bring_your_own_fips202/mlkem_native/mlkem_native_config.h

@@ -63,7 +63,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -76,7 +76,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/bring_your_own_fips202_static/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/bring_your_own_fips202_static/main.c

@@ -11,7 +11,6 @@
  * This requires specifying the parameter set and namespace prefix
  * used for the build.
  */
-#define MLK_CONFIG_NAMESPACE_PREFIX mlkem
 #include <mlkem_native.h>
 
 #include "test_only_rng/notrandombytes.h"

examples/bring_your_own_fips202_static/mlkem_native/mlkem_native_config.h

@@ -64,7 +64,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -77,7 +77,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/custom_backend/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/custom_backend/README.md

@@ -31,7 +31,7 @@ The configuration file [mlkem_native_config.h](mlkem_native/mlkem_native_config.
 
 A custom backend consists of:
 1. A metadata header (e.g., [custom.h](mlkem_native/src/fips202/native/custom/custom.h)) that:
-   - Sets `MLK_USE_FIPS202_X1_NATIVE` (and/or `X2`/`X4`) to indicate which functions are replaced
+   - Sets `MLK_USE_FIPS202_X1_NATIVE` (and/or `X4`) to indicate which functions are replaced
    - Includes the implementation header
 2. An implementation providing `mlk_keccakf1600_native()` (and/or batched variants)
 

examples/custom_backend/mlkem_native/mlkem_native_config.h

@@ -65,7 +65,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -78,7 +78,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/monolithic_build/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/monolithic_build/mlkem_native/mlkem_native_config.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -75,7 +75,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/monolithic_build_multilevel/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/monolithic_build_multilevel/mlkem_native/mlkem_native_config.h

@@ -63,7 +63,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -76,7 +76,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/monolithic_build_multilevel_native/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/monolithic_build_multilevel_native/mlkem_native/mlkem_native_config.h

@@ -67,7 +67,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -80,7 +80,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/monolithic_build_native/.gitignore

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+build

examples/monolithic_build_native/mlkem_native/mlkem_native_config.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -75,7 +75,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/multilevel_build/mlkem_native/mlkem_native_config.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -75,7 +75,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

examples/multilevel_build_native/mlkem_native/mlkem_native_config.h

@@ -64,7 +64,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -77,7 +77,7 @@
  *
  *****************************************************************************/
 /* No need to set this -- we _are_ already in a custom config */
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

mlkem/mlkem_native_config.h

@@ -46,7 +46,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -58,7 +58,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

mlkem/src/common.h

@@ -47,7 +47,7 @@
 /* Functions are prefixed by MLK_CONFIG_NAMESPACE_PREFIX.
  *
  * If multiple parameter sets are used, functions depending on the parameter
- * set are additionally prefixed with 512/768/1024. See config.h.
+ * set are additionally prefixed with 512/768/1024. See mlkem_native_config.h.
  *
  * Example: If MLK_CONFIG_NAMESPACE_PREFIX is mlkem, then
  * MLK_NAMESPACE_K(enc) becomes mlkem512_enc/mlkem768_enc/mlkem1024_enc.

mlkem/src/sys.h

@@ -235,8 +235,8 @@ __contract__(
    * If a feature is enabled at compile-time, we assume it is supported by
    * the host that the resulting library/binary will be built on.
    * If this assumption is not true, you MUST overwrite this function.
-   * See the documentation of MLK_CONFIG_CUSTOM_CAPABILITY_FUNC in config.h
-   * for more information. */
+   * See the documentation of MLK_CONFIG_CUSTOM_CAPABILITY_FUNC in
+   * mlkem_native_config.h for more information. */
   (void)cap;
   return 1;
 }

test/break_pct_config.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -74,7 +74,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

test/configs.yml

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
 
 # Metadata for test configuration files
-# Each entry describes how a test config differs from mlkem/src/config.h
+# Each entry describes how a test config differs from mlkem/mlkem_native_config.h
 
 configs:
   - path: test/no_asm_config.h

test/custom_memcpy_config.h

@@ -61,7 +61,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -73,7 +73,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

test/custom_memset_config.h

@@ -61,7 +61,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -73,7 +73,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

test/custom_native_capability_config_0.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -74,7 +74,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX

test/custom_native_capability_config_1.h

@@ -62,7 +62,7 @@
  * Name:        MLK_CONFIG_FILE
  *
  * Description: If defined, this is a header that will be included instead
- *              of the default configuration file mlkem/src/config.h.
+ *              of the default configuration file mlkem/mlkem_native_config.h.
  *
  *              When you need to build mlkem-native in multiple configurations,
  *              using varying MLK_CONFIG_FILE can be more convenient
@@ -74,7 +74,7 @@
  *              on the command line.
  *
  *****************************************************************************/
-/* #define MLK_CONFIG_FILE "config.h" */
+/* #define MLK_CONFIG_FILE "mlkem_native_config.h" */
 
 /******************************************************************************
  * Name:        MLK_CONFIG_NAMESPACE_PREFIX