From: Junio C Hamano Date: Wed, 6 Jul 2016 20:06:36 +0000 (-0700) Subject: Merge branch 'dn/gpg-doc' into maint X-Git-Tag: v2.9.1~31 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/17eb7a785851969f02f3b1736f5da11e9aa14949?ds=inline;hp=-c Merge branch 'dn/gpg-doc' into maint The documentation tries to consistently spell "GPG"; when referring to the specific program name, "gpg" is used. * dn/gpg-doc: Documentation: GPG capitalization --- 17eb7a785851969f02f3b1736f5da11e9aa14949 diff --combined Documentation/git-tag.txt index 4b1c1b8e5c,879958b640..6b89393746 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@@ -9,12 -9,12 +9,12 @@@ git-tag - Create, list, delete or verif SYNOPSIS -------- [verse] -'git tag' [-a | -s | -u ] [-f] [-m | -F ] +'git tag' [-a | -s | -u ] [-f] [-m | -F ] [ | ] 'git tag' -d ... 'git tag' [-n[]] -l [--contains ] [--points-at ] - [--column[=] | --no-column] [...] - [...] + [--column[=] | --no-column] [--create-reflog] [--sort=] + [--format=] [--[no-]merged []] [...] 'git tag' -v ... DESCRIPTION @@@ -25,19 -25,19 +25,19 @@@ to delete, list or verify tags Unless `-f` is given, the named tag must not yet exist. -If one of `-a`, `-s`, or `-u ` is passed, the command +If one of `-a`, `-s`, or `-u ` is passed, the command creates a 'tag' object, and requires a tag message. Unless `-m ` or `-F ` is given, an editor is started for the user to type in the tag message. -If `-m ` or `-F ` is given and `-a`, `-s`, and `-u ` +If `-m ` or `-F ` is given and `-a`, `-s`, and `-u ` are absent, `-a` is implied. Otherwise just a tag reference for the SHA-1 object name of the commit object is created (i.e. a lightweight tag). A GnuPG signed tag object will be created when `-s` or `-u -` is used. When `-u ` is not used, the +` is used. When `-u ` is not used, the committer identity for the current user is used to find the GnuPG key for signing. The configuration variable `gpg.program` is used to specify custom GnuPG binary. @@@ -64,8 -64,8 +64,8 @@@ OPTION --sign:: Make a GPG-signed tag, using the default e-mail address's key. --u :: ---local-user=:: +-u :: +--local-user=:: Make a GPG-signed tag, using the given key. -f:: @@@ -78,7 -78,7 +78,7 @@@ -v:: --verify:: - Verify the gpg signature of the given tag names. + Verify the GPG signature of the given tag names. -n:: specifies how many lines from the annotation, if any, @@@ -95,16 -95,14 +95,16 @@@ using fnmatch(3)). Multiple patterns may be given; if any of them matches, the tag is shown. ---sort=:: - Sort in a specific order. Supported type is "refname" - (lexicographic order), "version:refname" or "v:refname" (tag +--sort=:: + Sort based on the key given. Prefix `-` to sort in + descending order of the value. You may use the --sort= option + multiple times, in which case the last key becomes the primary + key. Also supports "version:refname" or "v:refname" (tag names are treated as versions). The "version:refname" sort order can also be affected by the - "versionsort.prereleaseSuffix" configuration variable. Prepend - "-" to reverse sort order. When this option is not given, the - sort order defaults to the value configured for the 'tag.sort' + "versionsort.prereleaseSuffix" configuration variable. + The keys supported are the same as those in `git for-each-ref`. + Sort order defaults to the value configured for the `tag.sort` variable if it exists, or lexicographic order otherwise. See linkgit:git-config[1]. @@@ -128,14 -126,14 +128,14 @@@ This option is only applicable when lis Use the given tag message (instead of prompting). If multiple `-m` options are given, their values are concatenated as separate paragraphs. - Implies `-a` if none of `-a`, `-s`, or `-u ` + Implies `-a` if none of `-a`, `-s`, or `-u ` is given. -F :: --file=:: Take the tag message from the given file. Use '-' to read the message from the standard input. - Implies `-a` if none of `-a`, `-s`, or `-u ` + Implies `-a` if none of `-a`, `-s`, or `-u ` is given. --cleanup=:: @@@ -145,9 -143,6 +145,9 @@@ all, 'whitespace' removes just leading/trailing whitespace lines and 'strip' removes both whitespace and commentary. +--create-reflog:: + Create a reflog for the tag. + :: The name of the tag to create, delete, or describe. The new tag name must pass all checks defined by @@@ -159,16 -154,6 +159,16 @@@ The object that the new tag will refer to, usually a commit. Defaults to HEAD. +:: + A string that interpolates `%(fieldname)` from the object + pointed at by a ref being shown. The format is the same as + that of linkgit:git-for-each-ref[1]. When unspecified, + defaults to `%(refname:strip=2)`. + +--[no-]merged []:: + Only list tags whose tips are reachable, or not reachable + if '--no-merged' is used, from the specified commit ('HEAD' + if not specified). CONFIGURATION ------------- @@@ -179,7 -164,7 +179,7 @@@ it in the repository configuration as f ------------------------------------- [user] - signingKey = + signingKey = ------------------------------------- diff --combined Documentation/git-verify-commit.txt index ecf4da16cf,8a5afdea23..92097f6673 --- a/Documentation/git-verify-commit.txt +++ b/Documentation/git-verify-commit.txt @@@ -12,14 -12,10 +12,14 @@@ SYNOPSI DESCRIPTION ----------- - Validates the gpg signature created by 'git commit -S'. + Validates the GPG signature created by 'git commit -S'. OPTIONS ------- +--raw:: + Print the raw gpg status output to standard error instead of the normal + human-readable output. + -v:: --verbose:: Print the contents of the commit object before validating it.