-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Description
In the USAGE
variable, the help message is:
[-d | --define] <identity> <name> <email> [<ssh-file>] [<gpgkeyid>]
or: git identity [--define-gpg] <identity> <gpgkeyid>
or: git identity [--define-ssh] <identity> <ssh-file> [<ssh-verbosity>]
or: git identity [-p | --print] [<identity>]
or: git identity [-s | --get-settings]
or: git identity [-r | --remove] <identity>
or: git identity [-l | --list]
or: git identity [-R | --list-raw]
or: git identity [-u | --update]
or: git identity [-c | --get-shell-command] [<identity>] [<command>]
or: git identity <identity>
Specific git-identity actions:
-d, --define define new identity and optionally specify ssh-file and gpg key
--define-gpg add gpg signature to the identity
--define-ssh add ssh key to an identity. If it does not have a path, assume '~/.ssh'
verbosity (0,1,2) of the ssh agent can also be specified
-p, --print print an indenttity or the current one
-r, --remove remove an identity
-s, --get-settings get the current settings that git-identity can changes
-l, --list list all the identities
-R, --list-raw list all identities without details
-u, --update refresh the local settings with the global settings of the current identity
-c,--get-shell-command get GIT_SSH_COMMAND environment variable for for an identity
if it followed by more parameter, execute a command with it
There are a few things wrong with this.
- The first line is missing the
git identity
at the start. - Putting
[]
around something means it's optional. When trying to indicate a group of alternatives that are required,()
is used: e.g.[-d | --define]
on the first line should be(-d | --define)
. - The
--get-shell-command
can only take a<command>
argument if<identity>
is passed but set explicitly to an empty string, which is not what the help text indicates. - The
<command>
argument to--get-shell-command
is actually a list of arguments that are taken as the command, which should be indicated as<command>...
Metadata
Metadata
Assignees
Labels
No labels