git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 1/4] doc: add some missing technical documents

From
Ramsay Jones <ramsay@ramsayjones.plus.com>
Date
Oct 2, 2025, 22:12 UTC
Message-ID
<20251002221233.541844-2-ramsay@ramsayjones.plus.com>
In-Reply-To
<20251002221233.541844-1-ramsay@ramsayjones.plus.com>

Commit bcf7edee09 ("meson: generate articles", 2024-12-27) added the generation of the 'howto' and 'technical' documents to the meson build. At this time those documents had a '*.txt' file extension, but they were renamed with an '*.adoc' extension by commit 1f010d6bdf ("doc: use .adoc extension for AsciiDoc files", 2025-01-20), for the most part. For the meson build, commit 87eccc3a81 ("meson: fix building technical and howto docs", 2025-03-02) fixed the meson.build files, which had not been updated when the files were renamed.

However, the 'Documentation/Makefile' has not been updated to include all of the recently added technical documents. In particular, the following are built by meson, but not by the Makefile:

    commit-graph.adoc
    directory-rename-detection.adoc
    packfile-uri.adoc
    remembering-renames.adoc
    repository-version.adoc
    rerere.adoc
    sparse-checkout.adoc
    sparse-index.adoc

In order to ensure that both build systems format the same technical documents, add the above documents to the TECH_DOCS variable in the Documentation/Makefile.

Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
---
 Documentation/Makefile | 8 ++++++++
 1 file changed, 8 insertions(+)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 6fb83d0c6e..a3fbd29744 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -119,18 +119,26 @@ TECH_DOCS += ToolsForGit
 TECH_DOCS += technical/bitmap-format
 TECH_DOCS += technical/build-systems
 TECH_DOCS += technical/bundle-uri
+TECH_DOCS += technical/commit-graph
+TECH_DOCS += technical/directory-rename-detection
 TECH_DOCS += technical/hash-function-transition
 TECH_DOCS += technical/long-running-process-protocol
 TECH_DOCS += technical/multi-pack-index
+TECH_DOCS += technical/packfile-uri
 TECH_DOCS += technical/pack-heuristics
 TECH_DOCS += technical/parallel-checkout
 TECH_DOCS += technical/partial-clone
 TECH_DOCS += technical/platform-support
 TECH_DOCS += technical/racy-git
 TECH_DOCS += technical/reftable
+TECH_DOCS += technical/remembering-renames
+TECH_DOCS += technical/repository-version
+TECH_DOCS += technical/rerere
 TECH_DOCS += technical/scalar
 TECH_DOCS += technical/send-pack-pipeline
 TECH_DOCS += technical/shallow
+TECH_DOCS += technical/sparse-checkout
+TECH_DOCS += technical/sparse-index
 TECH_DOCS += technical/trivial-merge
 TECH_DOCS += technical/unit-tests
 SP_ARTICLES += $(TECH_DOCS)
-- 
2.51.0
Previous: Ramsay JonesNext: Patrick Steinhardt
Message 2 of 25 in “technical docs in make build”
  1. 0/4 technical docs in make buildRamsay Jones, Oct 2, 2025
  2. 1/4 doc: add some missing technical documentsRamsay Jones, Oct 2, 2025
  3. Patrick SteinhardtOct 8, 2025
  4. Junio C HamanoOct 8, 2025
  5. Ramsay JonesOct 8, 2025
  6. Junio C HamanoOct 8, 2025
  7. Ramsay JonesOct 8, 2025
  8. 2/4 doc: remembering-renames.adoc: fix asciidoc warningsRamsay Jones, Oct 2, 2025
  9. Elijah NewrenOct 8, 2025
  10. Ramsay JonesOct 8, 2025
  11. 3/4 doc: sparse-checkout.adoc: fix asciidoc warningsRamsay Jones, Oct 2, 2025
  12. Kristoffer HaugsbakkOct 7, 2025
  13. Ramsay JonesOct 7, 2025
  14. Elijah NewrenOct 8, 2025
  15. Ramsay JonesOct 8, 2025
  16. 4/4 doc: commit-graph.adoc: fix up some formattingRamsay Jones, Oct 2, 2025
  17. Ramsay JonesOct 2, 2025
  18. 0/4 technical docs in make buildRamsay Jones, Oct 16, 2025
  19. 1/4 doc: remembering-renames.adoc: fix asciidoc warningsRamsay Jones, Oct 16, 2025
  20. 2/4 doc: sparse-checkout.adoc: fix asciidoc warningsRamsay Jones, Oct 16, 2025
  21. 3/4 doc: commit-graph.adoc: fix up some formattingRamsay Jones, Oct 16, 2025
  22. 4/4 doc: add large-object-promisors.adoc to the docs buildRamsay Jones, Oct 16, 2025
  23. Ramsay JonesOct 17, 2025
  24. Junio C HamanoOct 23, 2025
  25. Ramsay JonesOct 23, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.