git-config: Correct asciidoc documentation for --int/--bool
The asciidoc documentation seemed to indicate that type specifiers are honoured on writing operations which they aren't. Make this more clear. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
Frank Lichtenheld committed
May 21, 2007 at 00:12 UTC
0cb21911f49176866ee5170e292d351f4697634e
1 file changed
+9
-8
Documentation/git-config.txt
+9
-8
@@ -9,15 +9,15 @@ git-config - Get and set repository or global options
9
SYNOPSIS
10
--------
11
[verse]
12
-'git-config' [--system | --global] [type] name [value [value_regex]]
13
-'git-config' [--system | --global] [type] --add name value
14
-'git-config' [--system | --global] [type] --replace-all name [value [value_regex]]
12
+'git-config' [--system | --global] name [value [value_regex]]
13
+'git-config' [--system | --global] --add name value
14
+'git-config' [--system | --global] --replace-all name [value [value_regex]]
15
'git-config' [--system | --global] [type] --get name [value_regex]
16
'git-config' [--system | --global] [type] --get-all name [value_regex]
17
-'git-config' [--system | --global] [type] --unset name [value_regex]
18
-'git-config' [--system | --global] [type] --unset-all name [value_regex]
19
-'git-config' [--system | --global] [type] --rename-section old_name new_name
20
-'git-config' [--system | --global] [type] --remove-section name
17
+'git-config' [--system | --global] --unset name [value_regex]
18
+'git-config' [--system | --global] --unset-all name [value_regex]
19
+'git-config' [--system | --global] --rename-section old_name new_name
20
+'git-config' [--system | --global] --remove-section name
21
'git-config' [--system | --global] -l | --list
22
23
DESCRIPTION
@@ -36,7 +36,8 @@ prepend a single exclamation mark in front (see EXAMPLES).
36
The type specifier can be either '--int' or '--bool', which will make
37
'git-config' ensure that the variable(s) are of the given type and
38
convert the value to the canonical form (simple decimal number for int,
39
-a "true" or "false" string for bool). If no type specifier is passed,
39
+a "true" or "false" string for bool). Type specifiers currently only
40
+take effect for reading operations. If no type specifier is passed,
41
no checks or transformations are performed on the value.
42
43
This command will fail if: