]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation/technical/protocol-v2.txt: fix formatting
authorSZEDER Gábor <szeder.dev@gmail.com>
Fri, 29 Mar 2019 12:35:17 +0000 (13:35 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 1 Apr 2019 06:17:47 +0000 (15:17 +0900)
commitb373e4d29b7eb67a40efc038156a8edde7ae2972
treeabe98d95d0123ad55c553409d7fc36099eaf165f
parenteeb26f81850d83667d49b9e6d28ebec7c7aad8d8
Documentation/technical/protocol-v2.txt: fix formatting

Asciidoctor versions v1.5.7 or later print the following warning while
building the documentation:

      ASCIIDOC technical/protocol-v2.html
  asciidoctor: WARNING: protocol-v2.txt: line 38: unterminated listing block

This highlights an issue (even with older Asciidoctor versions) where
the 'Initial Client Request' header is not rendered as a header but in
monospace.  I'm not sure what exactly causes this issue and why it's
an issue only with this particular header, but all headers in
'protocol-v2.txt' are written like this:

   Initial Client Request
  ------------------------

i.e. the header itself is indented by a space, and the "underline" is
two characters longer than the header.

Dropping that indentation and making the length of the underline match
the length of the header apparently fixes this issue.

While at it, adjust all other headers 'protocol-v2.txt' as well, to
match the style we use everywhere else.

The page rendered with AsciiDoc doesn't have this formatting issue.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/protocol-v2.txt