From: John Keeping <john@keeping.me.uk>
To: Valentin VALCIU <axiac.ro@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: Formatting error in page http://git-scm.com/docs/user-manual
Date: Fri, 25 Sep 2015 13:59:35 +0100 [thread overview]
Message-ID: <20150925125935.GN17201@serenity.lan> (raw)
In-Reply-To: <CAOq7JjbYP=fGB0aqbrMz_ibfWHor-v-Y-BsO316H4dHpfSYS-w@mail.gmail.com>
On Fri, Sep 25, 2015 at 03:38:02PM +0300, Valentin VALCIU wrote:
> There is a formatting error in the source code of page
> http://git-scm.com/docs/user-manual that makes almost half of it be
> rendered in a <pre> element displaying the page source in the original
> markup language instead of being converted to HTML.
>
> The issue is in the paragraph that stars with "The index is a binary
> file (generally kept in `.git/index`)..."
It looks like the header underline isn't quite accurate enough to keep
Asciidoctor happy. The patch below should fix it.
-- >8 --
Subject: [PATCH] Documentation/user-manual: fix header underline
Asciidoctor is stricter than AsciiDoc when deciding if underlining is a
section title or the start of preformatted text. Make the length of the
underlining match the text to ensure that it renders correctly in all
implementations.
Signed-off-by: John Keeping <john@keeping.me.uk>
---
Documentation/user-manual.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 68978f5..1b7987e 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -3424,7 +3424,7 @@ just missing one particular blob version.
[[the-index]]
The index
------------
+---------
The index is a binary file (generally kept in `.git/index`) containing a
sorted list of path names, each with permissions and the SHA-1 of a blob
--
2.6.0.rc2.198.g81437b7
next prev parent reply other threads:[~2015-09-25 12:59 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-25 12:38 Formatting error in page http://git-scm.com/docs/user-manual Valentin VALCIU
2015-09-25 12:59 ` John Keeping [this message]
2015-09-25 14:29 ` Michael J Gruber
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=20150925125935.GN17201@serenity.lan \
--to=john@keeping.me.uk \
--cc=axiac.ro@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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