Skip to content

Commit be52a41

Browse files
raalkmlgitster
authored andcommitted
Make verse of git-config manpage more readable
Also mention '--file' in FILES. Signed-off-by: Alex Riesen <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 773a69f commit be52a41

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

Documentation/git-config.txt

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ git-config - Get and set repository or global options
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] name [value [value_regex]]
13-
'git-config' [--system | --global | [-f|--file] config-file] [type] --add name value
14-
'git-config' [--system | --global | [-f|--file] config-file] [type] --replace-all name [value [value_regex]]
15-
'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get name [value_regex]
16-
'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-all name [value_regex]
17-
'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-regexp name_regex [value_regex]
18-
'git-config' [--system | --global | [-f|--file] config-file] --unset name [value_regex]
19-
'git-config' [--system | --global | [-f|--file] config-file] --unset-all name [value_regex]
20-
'git-config' [--system | --global | [-f|--file] config-file] --rename-section old_name new_name
21-
'git-config' [--system | --global | [-f|--file] config-file] --remove-section name
22-
'git-config' [--system | --global | [-f|--file] config-file] [-z|--null] -l | --list
12+
'git-config' [<file-option>] [type] [-z|--null] name [value [value_regex]]
13+
'git-config' [<file-option>] [type] --add name value
14+
'git-config' [<file-option>] [type] --replace-all name [value [value_regex]]
15+
'git-config' [<file-option>] [type] [-z|--null] --get name [value_regex]
16+
'git-config' [<file-option>] [type] [-z|--null] --get-all name [value_regex]
17+
'git-config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
18+
'git-config' [<file-option>] --unset name [value_regex]
19+
'git-config' [<file-option>] --unset-all name [value_regex]
20+
'git-config' [<file-option>] --rename-section old_name new_name
21+
'git-config' [<file-option>] --remove-section name
22+
'git-config' [<file-option>] [-z|--null] -l | --list
2323

2424
DESCRIPTION
2525
-----------
@@ -40,6 +40,12 @@ convert the value to the canonical form (simple decimal number for int,
4040
a "true" or "false" string for bool). If no type specifier is passed,
4141
no checks or transformations are performed on the value.
4242

43+
The file-option can be one of '--system', '--global' or '--file'
44+
which specify where the values will be read from or written to.
45+
The default is to assume the config file of the current repository,
46+
.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
47+
(see <<FILES>>).
48+
4349
This command will fail if:
4450

4551
. The config file is invalid,
@@ -133,8 +139,8 @@ See also <<FILES>>.
133139
FILES
134140
-----
135141

136-
There are three files where git-config will search for configuration
137-
options:
142+
If not set explicitely with '--file', there are three files where
143+
git-config will search for configuration options:
138144

139145
.git/config::
140146
Repository specific configuration file. (The filename is

0 commit comments

Comments
 (0)