README: Add footnote regarding need for stdint.h and uint64_t

willieyz · hanno-becker · commit d32f6c30cb1e · 2026-02-14T09:16:57.000Z
This commit adds a footnote to README.md documenting that we
require the stdint.h header.

This commit made following change:

- `scripts/autogen` is modified to not try to interpret footnotes

- `[^FOO]` as bibliography entries if they have an explicit

  `[^FOO]: ...`
  entry outside of the bibliography section.

- Also, this commit remove the:
  `yield "#include &lt;stdint.h&gt;"`
  in autogen, and re-generate all zetas.c and *_table.c

Signed-off-by: willieyz &lt;willie.zhao@chelpis.com&gt;
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-mldsa-native is a secure, fast, and portable C90 implementation of the ML-DSA[^FIPS204] post-quantum signature standard. It is a fork of the ML-DSA reference implementation[^REF].
+mldsa-native is a secure, fast, and portable C90[^C90] implementation of the ML-DSA[^FIPS204] post-quantum signature standard. It is a fork of the ML-DSA reference implementation[^REF].
 
 mldsa-native is supported by the [Post-Quantum Cryptography Alliance](https://pqca.org/) as part of the [Linux Foundation](https://linuxfoundation.org/).
 
@@ -208,6 +208,9 @@ If you have any other question / non-security related issue / feature request, p
 If you want to help us build mldsa-native, please reach out. You can contact the mldsa-native team
 through the [PQCA Discord](https://discord.com/invite/xyVnwzfg5R). See also [CONTRIBUTING.md](CONTRIBUTING.md).
 
+[^C90]: Strictly speaking, we rely on C90 + `stdint.h` + 64-bit `unsigned long long`.
+
+
 <!--- bibliography --->
 [^ACVP]: National Institute of Standards and Technology: Automated Cryptographic Validation Protocol (ACVP) Server, [https://github.com/usnistgov/ACVP-Server](https://github.com/usnistgov/ACVP-Server)
 [^FIPS202]: National Institute of Standards and Technology: FIPS202 SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions, [https://csrc.nist.gov/pubs/fips/202/final](https://csrc.nist.gov/pubs/fips/202/final)
diff --git a/dev/aarch64_clean/src/aarch64_zetas.c b/dev/aarch64_clean/src/aarch64_zetas.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/aarch64_clean/src/rej_uniform_eta_table.c b/dev/aarch64_clean/src/rej_uniform_eta_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/aarch64_clean/src/rej_uniform_table.c b/dev/aarch64_clean/src/rej_uniform_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/aarch64_opt/src/aarch64_zetas.c b/dev/aarch64_opt/src/aarch64_zetas.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/aarch64_opt/src/rej_uniform_eta_table.c b/dev/aarch64_opt/src/rej_uniform_eta_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/aarch64_opt/src/rej_uniform_table.c b/dev/aarch64_opt/src/rej_uniform_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/dev/x86_64/src/rej_uniform_table.c b/dev/x86_64/src/rej_uniform_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_X86_64_DEFAULT) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_x86_64.h"
 
 /*
diff --git a/examples/bring_your_own_fips202_static/custom_fips202/README.md b/examples/bring_your_own_fips202_static/custom_fips202/README.md
@@ -37,7 +37,6 @@ using the parallel x4 API.
 - `tiny_sha3/` - Symlink to the tiny_sha3 implementation
 - `README.md` - This file
 
-[^tiny_sha3]: https://github.com/mjosaarinen/tiny_sha3
 
 <!--- bibliography --->
 [^tiny_sha3]: Markku-Juhani O. Saarinen: tiny_sha3, [https://github.com/mjosaarinen/tiny_sha3](https://github.com/mjosaarinen/tiny_sha3)
diff --git a/mldsa/src/native/aarch64/src/aarch64_zetas.c b/mldsa/src/native/aarch64/src/aarch64_zetas.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/mldsa/src/native/aarch64/src/rej_uniform_eta_table.c b/mldsa/src/native/aarch64/src/rej_uniform_eta_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/mldsa/src/native/aarch64/src/rej_uniform_table.c b/mldsa/src/native/aarch64/src/rej_uniform_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_AARCH64) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_aarch64.h"
 
 /*
diff --git a/mldsa/src/native/x86_64/src/rej_uniform_table.c b/mldsa/src/native/x86_64/src/rej_uniform_table.c
@@ -14,7 +14,6 @@
 #if defined(MLD_ARITH_BACKEND_X86_64_DEFAULT) && \
     !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)
 
-#include <stdint.h>
 #include "arith_native_x86_64.h"
 
 /*
diff --git a/mldsa/src/zetas.inc b/mldsa/src/zetas.inc
@@ -9,7 +9,6 @@
  *          Do not modify it directly.
  */
 
-#include <stdint.h>
 
 /*
  * Table of zeta values used in the reference NTT and inverse NTT.
diff --git a/scripts/autogen b/scripts/autogen
@@ -731,7 +731,6 @@ def gen_c_zetas():
 def gen_c_zeta_file():
     def gen():
         yield from gen_header()
-        yield "#include <stdint.h>"
         yield ""
         yield "/*"
         yield " * Table of zeta values used in the reference NTT and inverse NTT."
@@ -931,7 +930,6 @@ def gen_aarch64_zeta_file():
         yield "#if defined(MLD_ARITH_BACKEND_AARCH64) && \\"
         yield "    !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)"
         yield ""
-        yield "#include <stdint.h>"
         yield '#include "arith_native_aarch64.h"'
         yield ""
         yield "/*"
@@ -993,7 +991,6 @@ def gen_aarch64_rej_uniform_eta_table():
         yield "#if defined(MLD_ARITH_BACKEND_AARCH64) && \\"
         yield "    !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)"
         yield ""
-        yield "#include <stdint.h>"
         yield '#include "arith_native_aarch64.h"'
         yield ""
         yield "/*"
@@ -1045,7 +1042,6 @@ def gen_aarch64_rej_uniform_table():
         yield "#if defined(MLD_ARITH_BACKEND_AARCH64) && \\"
         yield "    !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)"
         yield ""
-        yield "#include <stdint.h>"
         yield '#include "arith_native_aarch64.h"'
         yield ""
         yield "/*"
@@ -1154,7 +1150,6 @@ def gen_avx2_rej_uniform_table():
         yield "#if defined(MLD_ARITH_BACKEND_X86_64_DEFAULT) && \\"
         yield "    !defined(MLD_CONFIG_MULTILEVEL_NO_SHARED)"
         yield ""
-        yield "#include <stdint.h>"
         yield '#include "arith_native_x86_64.h"'
         yield ""
         yield "/*"
@@ -2736,11 +2731,19 @@ def gen_markdown_citations_for(filename, bibliography):
     except ValueError:
         pass
 
+    # Find explicit footnote definitions outside the bibliography block
+    # These are lines matching `[^ID]: ...` and should be excluded from autogeneration
+    explicit_footnotes = set()
+    for l in content:
+        m = re.match(r"^\[\^(\w+)\]:", l)
+        if m:
+            explicit_footnotes.add(m.group(1))
+
     # Add footnotes for all citations found
-    if len(citations) > 0:
-        content.append(footnote_footer_start)
-    cite_ids = list(citations.keys())
+    cite_ids = [c for c in citations.keys() if c not in explicit_footnotes]
     cite_ids.sort()
+    if len(cite_ids) > 0:
+        content.append(footnote_footer_start)
     for cite_id in cite_ids:
         uses = citations[cite_id]
         entry = bibliography.get(cite_id, None)
@@ -2755,7 +2758,7 @@ def gen_markdown_citations_for(filename, bibliography):
         # Remember this usage of the bibliography entry
         entry.register_usages(uses)
 
-    if len(citations) > 0:
+    if len(cite_ids) > 0:
         content.append("")
 
     update_file(filename, "\n".join(content))
