[PATCH] documentation: git-config minor cleanups

[PATCH] documentation: git-config minor cleanups

[Cliff Frey]

Change push.default's description to add hyphens between values and
descriptions to make the manpage easier to read.  The html version is
readable either way.

Change status.showUntrackedFiles to make item descriptions be
sentences and to use the same asciidoc format as push.default.  The
only visual change is the additions of "."

Signed-off-by: Cliff Frey <cliff@meraki.com>
---
 Documentation/config.txt |   14 +++++++-------
 1 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 71ddb6c..1cd820d 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1560,12 +1560,12 @@ 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 matching branches.
+* `nothing` - do not push anything.
+* `matching` - push all matching branches.
   All branches having the same name in both ends are considered to be
   matching. This is the default.
-* `tracking` push the current branch to its upstream branch.
-* `current` push the current branch to a branch of the same name.
+* `tracking` - push the current branch to its upstream branch.
+* `current` - push the current branch to a branch of the same name.
 
 rebase.stat::
 	Whether to show a diffstat of what changed upstream since the last
@@ -1765,9 +1765,9 @@ status.showUntrackedFiles::
 	the untracked files. Possible values are:
 +
 --
-	- 'no'     - Show no untracked files
-	- 'normal' - Shows untracked files and directories
-	- 'all'    - Shows also individual files in untracked directories.
+* `no` - Show no untracked files.
+* `normal` - Shows untracked files and directories.
+* `all` - Shows also individual files in untracked directories.
 --
 +
 If this variable is not specified, it defaults to 'normal'.
-- 
1.7.3.1.120.g38a18

Re: [PATCH] documentation: git-config minor cleanups

[Jonathan Nieder]

Cliff Frey wrote:

> Change push.default's description to add hyphens between values and
> descriptions to make the manpage easier to read.  The html version is
> readable either way.
> 
> Change status.showUntrackedFiles to make item descriptions be
> sentences and to use the same asciidoc format as push.default.

Yep, it is hard to read

| ·    nothing do not push anything.
|
| ·    matching push all matching branches. All
|     branches having the same name in both ends are
[etc]

without the font change to indicate where each term begins and ends.

So for what it's worth:
Acked-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.

> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1765,9 +1765,9 @@ status.showUntrackedFiles::
>  	the untracked files. Possible values are:
>  +
>  --
> -	- 'no'     - Show no untracked files
> -	- 'normal' - Shows untracked files and directories
> -	- 'all'    - Shows also individual files in untracked directories.
> +* `no` - Show no untracked files.
> +* `normal` - Shows untracked files and directories.
> +* `all` - Shows also individual files in untracked directories.

If you are making these into sentences, they should be

 - Show no untracked...
 - Show untracked...
 - Also show...

, no?  [i.e., s/Shows/Show/c]