Skip to content

Commit a81383b

Browse files
Martin Ågrengitster
authored andcommitted
Doc/git-{push,send-pack}: correct --sign= to --signed=
Since we're about to touch the behavior of --signed=, do this as a preparatory step. The documentation mentions --sign=, and it works. But that's just because it's an unambiguous abbreviation of --signed, which is how it is actually implemented. This was added in commit 3026109 ("push: support signing pushes iff the server supports it", 2015-08-19). Back when that series was developed [1] [2], there were suggestions about both --sign= and --signed=. The final implementation settled on --signed=, but some of the documentation and commit messages ended up using --sign=. The option is referred to as --signed= in Documentation/config.txt (under push.gpgSign). One could argue that we have promised --sign for two years now, so we should implement it as an alias for --signed. (Then we might also deprecate the latter, something which was considered already then.) That would be a slightly more intrusive change. This minor issue would only be a problem once we want to implement some other option --signfoo, but the earlier we do this step, the better. [1] v1-thread: https://public-inbox.org/git/1439492451-11233-1-git-send-email-dborowitz@google.com/T/#u [2] v2-thread: https://public-inbox.org/git/1439998007-28719-1-git-send-email-dborowitz@google.com/T/#m6533a6c4707a30b0d81e86169ff8559460cbf6eb Signed-off-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent e7e07d5 commit a81383b

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

Documentation/git-push.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
'git push' [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
1313
[--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose]
1414
[-u | --set-upstream] [--push-option=<string>]
15-
[--[no-]signed|--sign=(true|false|if-asked)]
15+
[--[no-]signed|--signed=(true|false|if-asked)]
1616
[--force-with-lease[=<refname>[:<expect>]]]
1717
[--no-verify] [<repository> [<refspec>...]]
1818

@@ -141,7 +141,7 @@ already exists on the remote side.
141141
information, see `push.followTags` in linkgit:git-config[1].
142142

143143
--[no-]signed::
144-
--sign=(true|false|if-asked)::
144+
--signed=(true|false|if-asked)::
145145
GPG-sign the push request to update refs on the receiving
146146
side, to allow it to be checked by the hooks and/or be
147147
logged. If `false` or `--no-signed`, no signing will be

Documentation/git-send-pack.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SYNOPSIS
1111
[verse]
1212
'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
1313
[--verbose] [--thin] [--atomic]
14-
[--[no-]signed|--sign=(true|false|if-asked)]
14+
[--[no-]signed|--signed=(true|false|if-asked)]
1515
[<host>:]<directory> [<ref>...]
1616

1717
DESCRIPTION
@@ -71,7 +71,7 @@ be in a separate packet, and the list must end with a flush packet.
7171
refs.
7272

7373
--[no-]signed::
74-
--sign=(true|false|if-asked)::
74+
--signed=(true|false|if-asked)::
7575
GPG-sign the push request to update refs on the receiving
7676
side, to allow it to be checked by the hooks and/or be
7777
logged. If `false` or `--no-signed`, no signing will be

0 commit comments

Comments
 (0)