git-config.1: remove value from positional args in unset usage
The synopsis for `git config unset` mentions two positional arguments: `<name>` and `<value>`. While the first argument is correct, the second is not. Users are expected to provide the value via `--value=<value>`. Remove the positional argument. The `--value=<value>` option is already documented correctly, so this is all we need to do to fix the documentation. Signed-off-by: Josh Heinrichs <joshiheinrichs@gmail.com> Reviewed-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Josh Heinrichs committed
Oct 8, 2024 at 08:29 UTC
f36b8cbaefd8ba0f815ff05a79ddda3ee814a09f
2 files changed
+3
-3
Documentation/git-config.txt
+1
-1
@@ -12,7 +12,7 @@ SYNOPSIS
12
'git config list' [<file-option>] [<display-option>] [--includes]
13
'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>
14
'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>
15
-'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>
15
+'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>
16
'git config rename-section' [<file-option>] <old-name> <new-name>
17
'git config remove-section' [<file-option>] <name>
18
'git config edit' [<file-option>]
builtin/config.c
+2
-2
@@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = {
19
N_("git config list [<file-option>] [<display-option>] [--includes]"),
20
N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
21
N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
22
- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
22
+ N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
23
N_("git config rename-section [<file-option>] <old-name> <new-name>"),
24
N_("git config remove-section [<file-option>] <name>"),
25
N_("git config edit [<file-option>]"),
@@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = {
43
};
44
45
static const char *const builtin_config_unset_usage[] = {
46
- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
46
+ N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
47
NULL
48
};
49