Re: Formatting error in page http://git-scm.com/docs/user-manual
- From
John Keeping <john@keeping.me.uk>
- Date
- Sep 25, 2015, 12:59 UTC
- Message-ID
- <20150925125935.GN17201@serenity.lan>
- 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:
Show 7 quoted lines
> 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