From: Junio C Hamano Date: Wed, 15 Aug 2018 22:08:19 +0000 (-0700) Subject: Merge branch 'jk/ui-color-always-to-auto' X-Git-Tag: v2.19.0-rc0~87 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/5a6693089f599546adc2559d0117b91767b1f10c?ds=inline;hp=-c Merge branch 'jk/ui-color-always-to-auto' Doc formatting fix. * jk/ui-color-always-to-auto: Documentation: fix --color option formatting --- 5a6693089f599546adc2559d0117b91767b1f10c diff --combined Documentation/git-for-each-ref.txt index 085d177d97,183b15d4f8..901faef1bf --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@@ -57,7 -57,7 +57,7 @@@ OPTION `xx`; for example `%00` interpolates to `\0` (NUL), `%09` to `\t` (TAB) and `%0a` to `\n` (LF). - --color[=]: + --color[=]:: Respect any colors specified in the `--format` option. The `` field must be one of `always`, `never`, or `auto` (if `` is absent, behave as if `always` was given). @@@ -121,7 -121,7 +121,7 @@@ refname: stripping with positive , or it becomes the full refname if stripping with negative . Neither is an error. + -`strip` can be used as a synomym to `lstrip`. +`strip` can be used as a synonym to `lstrip`. objecttype:: The type of the object (`blob`, `tree`, `commit`, `tag`). @@@ -145,25 -145,18 +145,25 @@@ upstream: (behind), "<>" (ahead and behind), or "=" (in sync). `:track` also prints "[gone]" whenever unknown upstream ref is encountered. Append `:track,nobracket` to show tracking - information without brackets (i.e "ahead N, behind M"). Has - no effect if the ref does not have tracking information - associated with it. All the options apart from `nobracket` - are mutually exclusive, but if used together the last option - is selected. + information without brackets (i.e "ahead N, behind M"). ++ +For any remote-tracking branch `%(upstream)`, `%(upstream:remotename)` +and `%(upstream:remoteref)` refer to the name of the remote and the +name of the tracked remote ref, respectively. In other words, the +remote-tracking branch can be updated explicitly and individually by +using the refspec `%(upstream:remoteref):%(upstream)` to fetch from +`%(upstream:remotename)`. ++ +Has no effect if the ref does not have tracking information associated +with it. All the options apart from `nobracket` are mutually exclusive, +but if used together the last option is selected. push:: The name of a local ref which represents the `@{push}` location for the displayed ref. Respects `:short`, `:lstrip`, - `:rstrip`, `:track`, and `:trackshort` options as `upstream` - does. Produces an empty string if no `@{push}` ref is - configured. + `:rstrip`, `:track`, `:trackshort`, `:remotename`, and `:remoteref` + options as `upstream` does. Produces an empty string if no `@{push}` + ref is configured. HEAD:: '*' if HEAD matches current ref (the checked out branch), ' ' @@@ -225,15 -218,11 +225,15 @@@ and `date` to extract the named compone The complete message in a commit and tag object is `contents`. Its first line is `contents:subject`, where subject is the concatenation of all lines of the commit message up to the first blank line. The next -line is 'contents:body', where body is all of the lines after the first +line is `contents:body`, where body is all of the lines after the first blank line. The optional GPG signature is `contents:signature`. The first `N` lines of the message is obtained using `contents:lines=N`. Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1] -are obtained as 'contents:trailers'. +are obtained as `trailers` (or by using the historical alias +`contents:trailers`). Non-trailer lines from the trailer block can be omitted +with `trailers:only`. Whitespace-continuations can be removed from trailers so +that each trailer appears on a line by itself with its full content with +`trailers:unfold`. Both can be used together as `trailers:unfold,only`. For sorting purposes, fields with numeric values sort in numeric order (`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). diff --combined Documentation/git-tag.txt index 87c4288ffc,cef01e1a01..92f9c12b87 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@@ -9,7 -9,7 +9,7 @@@ 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 ] [-e] [ | ] 'git tag' -d ... 'git tag' [-n[]] -l [--contains ] [--no-contains ] @@@ -34,8 -34,8 +34,8 @@@ in the tag message 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). +Otherwise, a tag reference that points directly at the given object +(i.e., a lightweight tag) is created. A GnuPG signed tag object will be created when `-s` or `-u ` is used. When `-u ` is not used, the @@@ -115,7 -115,7 +115,7 @@@ options for details variable if it exists, or lexicographic order otherwise. See linkgit:git-config[1]. - --color[=]: + --color[=]:: Respect any colors specified in the `--format` option. The `` field must be one of `always`, `never`, or `auto` (if `` is absent, behave as if `always` was given). @@@ -167,12 -167,6 +167,12 @@@ This option is only applicable when lis Implies `-a` if none of `-a`, `-s`, or `-u ` is given. +-e:: +--edit:: + The message taken from file with `-F` and command line with + `-m` are usually used as the tag message unmodified. + This option lets you further edit the message taken from these sources. + --cleanup=:: This option sets how the tag message is cleaned up. The '' can be one of 'verbatim', 'whitespace' and 'strip'. The