Skip to content

Commit 48027f8

Browse files
nalladscho
authored andcommitted
asciidoctor: Fix user-manual to be built by asciidoctor
The `user-manual.txt` ist 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 *Apendix B* had no subsections which is not allowed when building with `asciidoctor`. So lets add a *dummy* section. Signed-off-by: nalla <[email protected]>
1 parent 710fe0c commit 48027f8

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
335335

336336
user-manual.xml: user-manual.txt user-manual.conf
337337
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
338-
$(TXT_TO_XML) -d article -o $@+ $< && \
338+
$(TXT_TO_XML) -d book -o $@+ $< && \
339339
mv $@+ $@
340340

341341
technical/api-index.txt: technical/api-index-skel.txt \

Documentation/user-manual.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3424,7 +3424,7 @@ just missing one particular blob version.
34243424

34253425
[[the-index]]
34263426
The index
3427-
-----------
3427+
---------
34283428

34293429
The index is a binary file (generally kept in `.git/index`) containing a
34303430
sorted list of path names, each with permissions and the SHA-1 of a blob
@@ -4366,6 +4366,10 @@ itself!
43664366
Git Glossary
43674367
============
43684368

4369+
[[git-explained]]
4370+
Git explained
4371+
-------------
4372+
43694373
include::glossary-content.txt[]
43704374

43714375
[[git-quick-start]]
@@ -4607,6 +4611,10 @@ $ git gc
46074611
Appendix B: Notes and todo list for this manual
46084612
===============================================
46094613

4614+
[[todo-list]]
4615+
Todo list
4616+
---------
4617+
46104618
This is a work in progress.
46114619

46124620
The basic requirements:

0 commit comments

Comments
 (0)