From 0393cf65024fa2021e5cf5a2c60c92b764bc4696 Mon Sep 17 00:00:00 2001 From: "H. Peter Anvin" Date: Tue, 23 Sep 2025 08:13:48 -0700 Subject: [PATCH] doc: document that appendices C, D and E should be unchanged Currently, the website links directly to appendix C, D, and E by name. At some point, change the HTML generation to use the chapter names rather than numbers. Signed-off-by: H. Peter Anvin (Intel) --- doc/nasmdoc.src | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/nasmdoc.src b/doc/nasmdoc.src index b26ea3a9..9402fe3c 100644 --- a/doc/nasmdoc.src +++ b/doc/nasmdoc.src @@ -94,12 +94,22 @@ source.} \& ndisasm.src -\# Keep the changelog as Appendix C if at all possible, otherwise -\# the website machinery needs to be changed. +\# --- Begin directly referenced appendices + +\# The following three appendices are linked to directly from the +\# website. Please keep them in their current position as appendices +\# C, D and E if at all possible. If they are reorganized, the website +\# will need to be updated. + +\# Appendix C: changelog/release notes \& changelog.src +\# Appendix D: building from source \& source.src +\# Appendix E: contact information \& contact.src +\# --- End directly referenced appendices + \& inslist.src