[PATCH] Make verse of git-config manpage more readable

From

Alex Riesen <raa.lkml@gmail.com>

Date

Jul 31, 2007, 22:01 UTC

Message-ID

<20070731220117.GA3196@steel.home>

In-Reply-To

<81b0412b0707310502x588c9c6dh7d9290360b27647a@mail.gmail.com>

Also mention '--file' in FILES.

Signed-off-by: Alex Riesen <raa.lkml@gmail.com>
---

Alex Riesen, Tue, Jul 31, 2007 14:02:13 +0200:

> On 7/31/07, Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > You could use this chance to make the verse nicer, i.e. split it into a
> > [<file-option>] and an [<action>] part.

 Documentation/git-config.txt |   32 +++++++++++++++++++-------------
 1 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 88acf6c..8451ccc 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -9,17 +9,17 @@ git-config - Get and set repository or global options
 SYNOPSIS
 --------
 [verse]
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] name [value [value_regex]]
-'git-config' [--system | --global | [-f|--file] config-file] [type] --add name value
-'git-config' [--system | --global | [-f|--file] config-file] [type] --replace-all name [value [value_regex]]
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get name [value_regex]
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-all name [value_regex]
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-regexp name_regex [value_regex]
-'git-config' [--system | --global | [-f|--file] config-file] --unset name [value_regex]
-'git-config' [--system | --global | [-f|--file] config-file] --unset-all name [value_regex]
-'git-config' [--system | --global | [-f|--file] config-file] --rename-section old_name new_name
-'git-config' [--system | --global | [-f|--file] config-file] --remove-section name
-'git-config' [--system | --global | [-f|--file] config-file] [-z|--null] -l | --list
+'git-config' [<file-option>] [type] [-z|--null] name [value [value_regex]]
+'git-config' [<file-option>] [type] --add name value
+'git-config' [<file-option>] [type] --replace-all name [value [value_regex]]
+'git-config' [<file-option>] [type] [-z|--null] --get name [value_regex]
+'git-config' [<file-option>] [type] [-z|--null] --get-all name [value_regex]
+'git-config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
+'git-config' [<file-option>] --unset name [value_regex]
+'git-config' [<file-option>] --unset-all name [value_regex]
+'git-config' [<file-option>] --rename-section old_name new_name
+'git-config' [<file-option>] --remove-section name
+'git-config' [<file-option>] [-z|--null] -l | --list
 
 DESCRIPTION
 -----------
@@ -40,6 +40,12 @@ convert the value to the canonical form (simple decimal number for int,
 a "true" or "false" string for bool).  If no type specifier is passed,
 no checks or transformations are performed on the value.
 
+The file-option can be one of '--system', '--global' or '--file'
+which specify where the values will be read from or written to.
+The default is to assume the config file of the current repository,
+.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
+(see <<FILES>>).
+
 This command will fail if:
 
 . The config file is invalid,
@@ -133,8 +139,8 @@ See also <<FILES>>.
 FILES
 -----
 
-There are three files where git-config will search for configuration
-options:
+If not set explicitely with '--file', there are three files where
+git-config will search for configuration options:
 
 .git/config::
 	Repository specific configuration file. (The filename is

-- 
1.5.3.rc3.116.g94fd8