[PATCH] Fix formatting in git-config(1)

[PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

Remove the open block markers from the status.showUntrackedFiles entry
as they cause all remaining entries to be indented one level too much.

Signed-off-by: Andreas Schwab <schwab@linux-m68k.org>
---
I haven't been able to make the paragraph after the nested list of the
entry indented the same as the first one.  That appears to be a bug in
asciidoc, unless I'm misunderstanding something.  What should have
worked, AFAICS, would be placing the last paragraph inside the open
block and remove the preceding continuation marker, but doesn't change
anything from the status quo.

Andreas.

 Documentation/config.txt | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 915cb5a..182ca3d 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1946,11 +1946,9 @@ status.showUntrackedFiles::
 	systems. So, this variable controls how the commands displays
 	the untracked files. Possible values are:
 +
---
 * `no` - Show no untracked files.
 * `normal` - Show untracked files and directories.
 * `all` - Show also individual files in untracked directories.
---
 +
 If this variable is not specified, it defaults to 'normal'.
 This variable can be overridden with the -u|--untracked-files option
-- 
1.7.11


-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Junio C Hamano]

Andreas Schwab <schwab@linux-m68k.org> writes:

> Remove the open block markers from the status.showUntrackedFiles entry
> as they cause all remaining entries to be indented one level too much.

Hrm...

I looked at http://git-htmldocs.googlecode.com/git/git-config.html
and am unsure what "one level too much" you are referring to.  Also
looking at the output from

$ git config --help

I see (RHS end truncated to avoid line wrapping in MUA):

    status.showUntrackedFiles
        By default, git-status(1) and git-commit(1) show files whi
        tracked by Git. Directories which contain only untracked f
        the directory name only. Showing untracked files means tha
        lstat() all all the files in the whole repository, which m
        systems. So, this variable controls how the commands displ
        files. Possible values are:

        ·    no - Show no untracked files.

        ·    normal - Show untracked files and directories.

        ·    all - Show also individual files in untracked directo

        If this variable is not specified, it defaults to normal. 
        overridden with the -u|--untracked-files option of git-sta
        commit(1).

Re: [PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

Junio C Hamano <gitster@pobox.com> writes:

> Andreas Schwab <schwab@linux-m68k.org> writes:
>
>> Remove the open block markers from the status.showUntrackedFiles entry
>> as they cause all remaining entries to be indented one level too much.
>
> Hrm...
>
> I looked at http://git-htmldocs.googlecode.com/git/git-config.html
> and am unsure what "one level too much" you are referring to.

I'm using asciidoc 8.4.5.  Probably version dependent.

> Also looking at the output from
>
> $ git config --help
>
> I see (RHS end truncated to avoid line wrapping in MUA):

This is what I see:

       status.showUntrackedFiles
           By default, git-status(1) and git-commit(1) show files which are
           not currently tracked by Git. Directories which contain only
           untracked files, are shown with the directory name only. Showing
           untracked files means that Git needs to lstat() all all the files
           in the whole repository, which might be slow on some systems. So,
           this variable controls how the commands displays the untracked
           files. Possible values are:

           ·    no - Show no untracked files.

           ·    normal - Show untracked files and directories.

           ·    all - Show also individual files in untracked directories.
               If this variable is not specified, it defaults to normal. This
               variable can be overridden with the -u|--untracked-files option
               of git-status(1) and git-commit(1).

           status.submodulesummary
               Defaults to false. If this is set to a non zero number or true
               (identical to -1 or an unlimited number), the submodule summary
               will be enabled and a summary of commits for modified
               submodules will be shown (see --summary-limit option of git-
               submodule(1)).


Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Junio C Hamano]

Junio C Hamano <gitster@pobox.com> writes:

> Andreas Schwab <schwab@linux-m68k.org> writes:
>
>> Remove the open block markers from the status.showUntrackedFiles entry
>> as they cause all remaining entries to be indented one level too much.
>
> Hrm...
>
> I looked at http://git-htmldocs.googlecode.com/git/git-config.html
> and am unsure what "one level too much" you are referring to.  Also
> looking at the output from
>
> $ git config --help
>
> I see (RHS end truncated to avoid line wrapping in MUA):
>
>     status.showUntrackedFiles
>         By default, git-status(1) and git-commit(1) show files whi
>         tracked by Git. Directories which contain only untracked f
>         the directory name only. Showing untracked files means tha
>         lstat() all all the files in the whole repository, which m
>         systems. So, this variable controls how the commands displ
>         files. Possible values are:
>
>         ·    no - Show no untracked files.
>
>         ·    normal - Show untracked files and directories.
>
>         ·    all - Show also individual files in untracked directo
>
>         If this variable is not specified, it defaults to normal. 
>         overridden with the -u|--untracked-files option of git-sta
>         commit(1).

Worse yet, with AsciiDoc 8.5.2, here is what I see with your patch
(again, RHS end truncated to avoid line wrapping in MUA):

    status.showUntrackedFiles

            By default, git-status(1) and git-commit(1) show files w
            Directories which contain only untracked files, are show
            Showing untracked files means that Git needs to lstat() 
            repository, which might be slow on some systems. So, thi
            displays the untracked files. Possible values are:

               * no - Show no untracked files.

               * normal - Show untracked files and directories.

               * all - Show also individual files in untracked direc

                 If this variable is not specified, it defaults to n
                 with the -u|--untracked-files option of git-status(

So...

Re: [PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

Junio C Hamano <gitster@pobox.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>> Andreas Schwab <schwab@linux-m68k.org> writes:
>>
>>> Remove the open block markers from the status.showUntrackedFiles entry
>>> as they cause all remaining entries to be indented one level too much.
>>
>> Hrm...
>>
>> I looked at http://git-htmldocs.googlecode.com/git/git-config.html
>> and am unsure what "one level too much" you are referring to.  Also
>> looking at the output from
>>
>> $ git config --help
>>
>> I see (RHS end truncated to avoid line wrapping in MUA):
>>
>>     status.showUntrackedFiles
>>         By default, git-status(1) and git-commit(1) show files whi
>>         tracked by Git. Directories which contain only untracked f
>>         the directory name only. Showing untracked files means tha
>>         lstat() all all the files in the whole repository, which m
>>         systems. So, this variable controls how the commands displ
>>         files. Possible values are:
>>
>>         ·    no - Show no untracked files.
>>
>>         ·    normal - Show untracked files and directories.
>>
>>         ·    all - Show also individual files in untracked directo
>>
>>         If this variable is not specified, it defaults to normal. 
>>         overridden with the -u|--untracked-files option of git-sta
>>         commit(1).
>
> Worse yet, with AsciiDoc 8.5.2, here is what I see with your patch
> (again, RHS end truncated to avoid line wrapping in MUA):
>
>     status.showUntrackedFiles
>
>             By default, git-status(1) and git-commit(1) show files w
>             Directories which contain only untracked files, are show
>             Showing untracked files means that Git needs to lstat() 
>             repository, which might be slow on some systems. So, thi
>             displays the untracked files. Possible values are:
>
>                * no - Show no untracked files.
>
>                * normal - Show untracked files and directories.
>
>                * all - Show also individual files in untracked direc
>
>                  If this variable is not specified, it defaults to n
>                  with the -u|--untracked-files option of git-status(
>
> So...

I get this layout no matter what, with and without the block markers,
both with version 8.4.5 and 8.6.6.  But with the block markers the
remaining entries are indented too much.

So...

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Junio C Hamano]

Andreas Schwab <schwab@linux-m68k.org> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>> Junio C Hamano <gitster@pobox.com> writes:
>>
>>> Andreas Schwab <schwab@linux-m68k.org> writes:
>>>
>>>> Remove the open block markers from the status.showUntrackedFiles entry
>>>> as they cause all remaining entries to be indented one level too much.
>>>
>>> Hrm...
>>>
>>> I looked at http://git-htmldocs.googlecode.com/git/git-config.html
>>> and am unsure what "one level too much" you are referring to.  Also
>>> looking at the output from
>>>
>>> $ git config --help
>>>
>>> I see (RHS end truncated to avoid line wrapping in MUA):
>>>
>>>     status.showUntrackedFiles
>>>         By default, git-status(1) and git-commit(1) show files whi
>>>         tracked by Git. Directories which contain only untracked f
>>>         the directory name only. Showing untracked files means tha
>>>         lstat() all all the files in the whole repository, which m
>>>         systems. So, this variable controls how the commands displ
>>>         files. Possible values are:
>>>
>>>         ·    no - Show no untracked files.
>>>
>>>         ·    normal - Show untracked files and directories.
>>>
>>>         ·    all - Show also individual files in untracked directo
>>>
>>>         If this variable is not specified, it defaults to normal. 
>>>         overridden with the -u|--untracked-files option of git-sta
>>>         commit(1).
>>
>> Worse yet, with AsciiDoc 8.5.2, here is what I see with your patch
>> (again, RHS end truncated to avoid line wrapping in MUA):
>>
>>     status.showUntrackedFiles
>>
>>             By default, git-status(1) and git-commit(1) show files w
>>             Directories which contain only untracked files, are show
>>             Showing untracked files means that Git needs to lstat() 
>>             repository, which might be slow on some systems. So, thi
>>             displays the untracked files. Possible values are:
>>
>>                * no - Show no untracked files.
>>
>>                * normal - Show untracked files and directories.
>>
>>                * all - Show also individual files in untracked direc
>>
>>                  If this variable is not specified, it defaults to n
>>                  with the -u|--untracked-files option of git-status(
>>
>> So...
>
> I get this layout no matter what, with and without the block markers,
> both with version 8.4.5 and 8.6.6.  But with the block markers the
> remaining entries are indented too much.
>
> So...

So with your patch, users of AsciiDoc 8.5.2 will be harmed by the
same breakage as you get with 8.4.5 and 8.6.6 with or without your
patch, and without your patch, users of AsciiDoc 8.5.2 gets a lot
more reasonable output than with your patch?

Can't we have a patch that makes everybody happier than what each is
currently seeing---that would be a progress without regression to
anybody.

Re: [PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

Junio C Hamano <gitster@pobox.com> writes:

> So with your patch, users of AsciiDoc 8.5.2 will be harmed by the
> same breakage as you get with 8.4.5 and 8.6.6 with or without your
> patch, and without your patch, users of AsciiDoc 8.5.2 gets a lot
> more reasonable output than with your patch?

The behaviour is completely independent from the asciidoc version.  All
three versions produce the same output.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

I've now found out that this is a bug in the docbook-xsl stylesheets,
updating to 1.77.1 fixed the formatting.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Junio C Hamano]

Andreas Schwab <schwab@linux-m68k.org> writes:

> I've now found out that this is a bug in the docbook-xsl stylesheets,
> updating to 1.77.1 fixed the formatting.

Thanks for digging!

[PATCH] Fix formatting in git-config(1)

[Andreas Schwab]

This fixes two formatting bugs in the git-config documentation:

- in the column.ui entry don't indent the last paragraph so that it isn't
  formatted as a literal paragraph
- in the push.default entry separate the last paragraph from the
  nested list.

Signed-off-by: Andreas Schwab <schwab@linux-m68k.org>
---
 Documentation/config.txt | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 915cb5a..b059851 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -880,7 +880,7 @@ column.ui::
 	make equal size columns
 --
 +
-	This option defaults to 'never'.
+This option defaults to 'never'.
 
 column.branch::
 	Specify whether to output branch listing in `git branch` in columns.
@@ -1720,6 +1720,7 @@ push.default::
 	no refspec is implied by any of the options given on the command
 	line. Possible values are:
 +
+--
 * `nothing` - do not push anything.
 * `matching` - push all branches having the same name in both ends.
   This is for those who prepare all the branches into a publishable
@@ -1739,12 +1740,13 @@ push.default::
   option and is well-suited for beginners. It will become the default
   in Git 2.0.
 * `current` - push the current branch to a branch of the same name.
-  +
-  The `simple`, `current` and `upstream` modes are for those who want to
-  push out a single branch after finishing work, even when the other
-  branches are not yet ready to be pushed out. If you are working with
-  other people to push into the same shared repository, you would want
-  to use one of these.
+--
++
+The `simple`, `current` and `upstream` modes are for those who want to
+push out a single branch after finishing work, even when the other
+branches are not yet ready to be pushed out. If you are working with
+other people to push into the same shared repository, you would want
+to use one of these.
 
 rebase.stat::
 	Whether to show a diffstat of what changed upstream since the last
-- 
1.7.11.1


-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: [PATCH] Fix formatting in git-config(1)

[Junio C Hamano]

Andreas Schwab <schwab@linux-m68k.org> writes:

> This fixes two formatting bugs in the git-config documentation:
>
> - in the column.ui entry don't indent the last paragraph so that it isn't
>   formatted as a literal paragraph
> - in the push.default entry separate the last paragraph from the
>   nested list.
>
> Signed-off-by: Andreas Schwab <schwab@linux-m68k.org>

Thanks.