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

[PATCH 1/2] asciidoctor: fix user-manual to be built by `asciidoctor`

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Jan 2, 2017, 16:03 UTC
Message-ID
<3c160f81a88cf8697f2459bb7f2a3e27fb3e469c.1483373021.git.johannes.schindelin@gmx.de>
In-Reply-To
<cover.1483373021.git.johannes.schindelin@gmx.de>
From: =?UTF-8?q?=EB=A7=88=EB=88=84=EC=97=98?= <nalla@hamal.uberspace.de>

The `user-manual.txt` is designed as a `book` but the `Makefile` wants to build it as an `article`. This seems to be a problem when building the documentation with `asciidoctor`. Furthermore the parts *Git Glossary* and *Appendix B* had no subsections which is not allowed when building with `asciidoctor`. So lets add a *dummy* section.

Signed-off-by: 마누엘 <nalla@hamal.uberspace.de>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 Documentation/Makefile        | 2 +-
 Documentation/user-manual.txt | 8 ++++++++
 2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index b43d66eae6..a9fb497b83 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -337,7 +337,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
 
 user-manual.xml: user-manual.txt user-manual.conf
 	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
-	$(TXT_TO_XML) -d article -o $@+ $< && \
+	$(TXT_TO_XML) -d book -o $@+ $< && \
 	mv $@+ $@
 
 technical/api-index.txt: technical/api-index-skel.txt \
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 5e07454572..bc29298678 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -4395,6 +4395,10 @@ itself!
 Git Glossary
 ============
 
+[[git-explained]]
+Git explained
+-------------
+
 include::glossary-content.txt[]
 
 [[git-quick-start]]
@@ -4636,6 +4640,10 @@ $ git gc
 Appendix B: Notes and todo list for this manual
 ===============================================
 
+[[todo-list]]
+Todo list
+---------
+
 This is a work in progress.
 
 The basic requirements:
-- 
2.11.0.rc3.windows.1
Previous: Johannes SchindelinNext: Jeff King
Message 2 of 18 in “Fix the documentation to build with asciidoctor”
  1. 0/2 Fix the documentation to build with asciidoctorJohannes Schindelin, Jan 2, 2017
  2. 1/2 asciidoctor: fix user-manual to be built by `asciidoctor`Johannes Schindelin, Jan 2, 2017
  3. Jeff KingJan 4, 2017
  4. Lars SchneiderJan 5, 2017
  5. Johannes SchindelinJan 5, 2017
  6. Jeff KingJan 5, 2017
  7. Junio C HamanoJan 7, 2017
  8. brian m. carlsonJan 7, 2017
  9. Junio C HamanoJan 10, 2017
  10. Junio C HamanoJan 7, 2017
  11. Jeff KingJan 8, 2017
  12. Junio C HamanoJan 10, 2017
  13. Johannes SchindelinJan 12, 2017
  14. Junio C HamanoJan 12, 2017
  15. Junio C HamanoJan 13, 2017
  16. 2/2 giteveryday: unbreak rendering with AsciiDoctorJohannes Schindelin, Jan 2, 2017
  17. Jeff KingJan 4, 2017
  18. Junio C HamanoJan 7, 2017

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.