diff mbox series

[2/4] git-init.txt: do not nest open blocks

Message ID 20181215112742.1475882-3-martin.agren@gmail.com (mailing list archive)
State New, archived
Headers show
Series A few Asciidoctor-fixes | expand

Commit Message

Martin Ågren Dec. 15, 2018, 11:27 a.m. UTC
It appears we try to nest open blocks, but that does not work well with
Asciidoctor, which fails to indent the inner block. This causes the
inner block to be set as if it had nothing to do with `--shared`. Drop
the outer one. Asciidoc renders identically before and after this patch,
both man-page and html.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 See https://git-scm.com/docs/git-init#git-init---sharedfalsetrueumaskgroupallworldeverybody0xxx

 Documentation/git-init.txt | 4 ----
 1 file changed, 4 deletions(-)

Comments

Jeff King Dec. 16, 2018, 10:55 a.m. UTC | #1
On Sat, Dec 15, 2018 at 12:27:40PM +0100, Martin Ågren wrote:

> It appears we try to nest open blocks, but that does not work well with
> Asciidoctor, which fails to indent the inner block. This causes the
> inner block to be set as if it had nothing to do with `--shared`. Drop
> the outer one. Asciidoc renders identically before and after this patch,
> both man-page and html.

Hrm. I'm not sure how we're supposed to have a block-within-a-block in
asciidoctor, and that may be something we want to fix in the long run.
But I agree this block around all of the options is not doing anything
useful, and the simplest solution here is just to get rid of it.

It dates all the way back to d145144c3b (Document git-init, 2007-01-11),
so perhaps it did something useful in an ancient version of asciidoc.

-Peff
diff mbox series

Patch

diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 3c5a67fb96..057076ca38 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -38,8 +38,6 @@  the repository to another place if --separate-git-dir is given).
 OPTIONS
 -------
 
---
-
 -q::
 --quiet::
 
@@ -111,8 +109,6 @@  into it.
 If you provide a 'directory', the command is run inside it. If this directory
 does not exist, it will be created.
 
---
-
 TEMPLATE DIRECTORY
 ------------------