[PATCH][GSoC] user-manual.txt: fix empty heading of introduction

From: Firmin Martin <firminmartin24@gmail.com>
Date: Apr 2, 2021, 12:13 UTC
Message-ID: <20210402121303.344914-1-firminmartin24@gmail.com>

Two among the three warnings raised by "make git.info" are related to the fact that the introductory heading being empty in user-manual.txt.

    user-manual.texi:15: warning: empty menu entry name in `* : idm4.'
    user-manual.texi:141: warning: @unnumbered missing argument

Recall that the dependencies chain is as follows:

    user-manual.txt => user-manual.xml => user-manual.texi => git.info

Asciidoc creates an empty title tag in user-manual.xml which turns to be an empty node in user-manual.texi and git.info. This is not negligible in those files as docbook2x-texi creates a node "idm4" in the menu and the navigation bar, which can be confusing for the average user: in Emacs, the first entry of the menu in the git info page is even displayed as empty.

Note that this fix will create an "Introduction" section in the files: user-manual.{xml, texi, html, pdf} and git.info.

For future reference, here are the content of the relevant & auto-generated files before this commit.

user-manual.xml:

    l07|<bookinfo>
    l08|<title>Git User Manual</title>
    l09|</bookinfo>
    l10|<preface>
    l11|<title></title>
    l12|<simpara>Git is a fast distributed revision control system.</simpara>

user-manual.texi:

    l10 |@node Top, idm4, , (dir)
    ... |
    l14 |@menu
    l15 |* : idm4.
    ... |
    l140|@node idm4, Repositories and Branches, Top, Top
    l141|@unnumbered
    ... | ...
    l181|@node Repositories and Branches, Exploring Git history, idm4, Top

git.info:

    l10  |File: git.info,  Node: Top,  Next: idm4,  Up: (dir)
    ...  | ...
    l15  |* Menu:
    l16  |
    l17  |* : idm4.
    ...  | ...
    l140 |File: git.info,  Node: idm4,  Next: Repositories and Branches,  Prev: Top,  Up: Top
    ...  | ...
    l177 |File: git.info,  Node: Repositories and Branches,  Next: Exploring Git history,  Prev: idm4,  Up: Top
    ...  | ...
    l5474|Node: idm43164

Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
 Documentation/user-manual.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index fd480b8645..d708612da2 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1,5 +1,8 @@
 = Git User Manual
 
+[[introduction]]
+== Introduction
+
 Git is a fast distributed revision control system.
 
 This manual is designed to be readable by someone with basic UNIX

-- 
2.31.1.133.g84d06cdc06