From: Junio C Hamano <gitster@pobox.com>
To: Firmin Martin <firminmartin24@gmail.com>
Cc: git@vger.kernel.org, "J. Bruce Fields" <bfields@citi.umich.edu>
Subject: Re: [PATCH][GSoC] user-manual.txt: fix empty heading of introduction
Date: Fri, 02 Apr 2021 15:23:22 -0700 [thread overview]
Message-ID: <xmqqblaw2un9.fsf@gitster.g> (raw)
In-Reply-To: <xmqqsg482x4f.fsf@gitster.g> (Junio C. Hamano's message of "Fri, 02 Apr 2021 14:29:52 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Junio C Hamano <gitster@pobox.com> writes:
>
>> Firmin Martin <firminmartin24@gmail.com> writes:
>>
>>> For future reference, here are the content of the relevant & auto-generated files
>>> before this commit.
>>
>> I would have expected to see "before and after". Is it too obvious
>> what the postimage would be? Otherwise, a better presentation would
>> be to show (an excerpt from) diff between preimage and postimage
>> output.
>>
>> Thanks.
>
> Another thing to look out for. I do not think git.info is the only
> consumer of user-manual.txt. Does this change affect the other
> consumer, user-manual.html, and if so how?
So, here is what "before and after" of the user-manual.xml output
file looks like. It shows that the standalone document loses its
Preface and all the chapters have been renumbered (because what was
in the Preface has become the first chapter).
To pages like http://git-scm.com/docs/user-manual that take our
source material and show them in preformatted, this change will
cascade through. Hopefully these places won't be upset for not
having the Preface (e.g. this particular site does not even refer
to the chapters as "chapter 1", "chapter 2", etc.) but we'd never
know until we try and break them ;-)
--- user-manual-without-patch.xml
+++ user-manual.xml
@@ -7,8 +7,8 @@
<bookinfo>
<title>Git User Manual</title>
</bookinfo>
-<preface>
-<title></title>
+<chapter id="introduction">
+<title>Introduction</title>
<simpara>Git is a fast distributed revision control system.</simpara>
<simpara>This manual is designed to be readable by someone with basic UNIX
command-line skills, but no previous knowledge of Git.</simpara>
@@ -31,7 +31,7 @@ pages, or <ulink url="git-help.html">git-help(1)
without any explanation.</simpara>
<simpara>Finally, see <xref linkend="todo"/> for ways that you can help make this manual more
complete.</simpara>
-</preface>
+</chapter>
<chapter id="repositories-and-branches">
<title>Repositories and Branches</title>
<section id="how-to-get-a-git-repository">
next prev parent reply other threads:[~2021-04-02 22:23 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-02 12:13 [PATCH][GSoC] user-manual.txt: fix empty heading of introduction Firmin Martin
2021-04-02 21:22 ` Junio C Hamano
2021-04-02 21:29 ` Junio C Hamano
2021-04-02 22:23 ` Junio C Hamano [this message]
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqblaw2un9.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=bfields@citi.umich.edu \
--cc=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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).