From: Firmin Martin <firminmartin24@gmail.com>
To: git@vger.kernel.org
Cc: Firmin Martin <firminmartin24@gmail.com>
Subject: [PATCH][GSoC] user-manual.txt: fix empty heading of introduction
Date: Fri, 2 Apr 2021 14:13:03 +0200 [thread overview]
Message-ID: <20210402121303.344914-1-firminmartin24@gmail.com> (raw)
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: idm4\x7f3164
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
next reply other threads:[~2021-04-02 12:23 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-02 12:13 Firmin Martin [this message]
2021-04-02 21:22 ` [PATCH][GSoC] user-manual.txt: fix empty heading of introduction Junio C Hamano
2021-04-02 21:29 ` Junio C Hamano
2021-04-02 22:23 ` Junio C Hamano
2021-04-03 5:16 ` Bagas Sanjaya
2021-04-04 0:46 ` Junio C Hamano
2021-04-04 4:07 ` [PATCH v2 0/1] user-manual.txt: assign preface an id and a title Firmin Martin
2021-04-04 4:07 ` [PATCH v2 1/1] " Firmin Martin
2021-04-04 6:21 ` Junio C Hamano
2021-04-04 4:31 ` [PATCH v2 0/1] " Firmin Martin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210402121303.344914-1-firminmartin24@gmail.com \
--to=firminmartin24@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).