development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-09-13 21:34:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'kd/doc-for-each-ref'

Browse source 
Doc update.

* kd/doc-for-each-ref:
  doc/for-each-ref: explicitly specify option names
  doc/for-each-ref: consistently use '=' to between argument names and values
This commit is contained in:
Junio C Hamano 2017-09-25 15:24:06 +09:00
parent b9db14f52e f7a32dd97f
commit f5faef8525
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
Documentation/git-for-each-ref.txt
View file

@ -10,8 +10,9 @@ SYNOPSIS
[verse] [verse]
'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
[(--sort=<key>)...] [--format=<format>] [<pattern>...] [(--sort=<key>)...] [--format=<format>] [<pattern>...]
[--points-at <object>] [(--merged | --no-merged) [<object>]] [--points-at=<object>]
[--contains [<object>]] [--no-contains [<object>]] (--merged[=<object>] | --no-merged[=<object>])
[--contains[=<object>]] [--no-contains[=<object>]]
DESCRIPTION DESCRIPTION
----------- -----------
@ -25,19 +26,25 @@ host language allowing their direct evaluation in that language.
OPTIONS OPTIONS
------- -------
<count>:: <pattern>...::
If one or more patterns are given, only refs are shown that
match against at least one pattern, either using fnmatch(3) or
literally, in the latter case matching completely or from the
beginning up to a slash.
--count=<count>::
By default the command shows all refs that match By default the command shows all refs that match
`<pattern>`. This option makes it stop after showing `<pattern>`. This option makes it stop after showing
that many refs. that many refs.
<key>:: --sort=<key>::
A field name to sort on. Prefix `-` to sort in A field name to sort on. Prefix `-` to sort in
descending order of the value. When unspecified, descending order of the value. When unspecified,
`refname` is used. You may use the --sort=<key> option `refname` is used. You may use the --sort=<key> option
multiple times, in which case the last key becomes the primary multiple times, in which case the last key becomes the primary
key. key.
<format>:: --format=<format>::
A string that interpolates `%(fieldname)` from a ref being shown A string that interpolates `%(fieldname)` from a ref being shown
and the object it points at. If `fieldname` and the object it points at. If `fieldname`
is prefixed with an asterisk (`*`) and the ref points is prefixed with an asterisk (`*`) and the ref points
@ -50,12 +57,6 @@ OPTIONS
`xx`; for example `%00` interpolates to `\0` (NUL), `xx`; for example `%00` interpolates to `\0` (NUL),
`%09` to `\t` (TAB) and `%0a` to `\n` (LF). `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
<pattern>...::
If one or more patterns are given, only refs are shown that
match against at least one pattern, either using fnmatch(3) or
literally, in the latter case matching completely or from the
beginning up to a slash.
--shell:: --shell::
--perl:: --perl::
--python:: --python::
@ -65,24 +66,24 @@ OPTIONS
the specified host language. This is meant to produce the specified host language. This is meant to produce
a scriptlet that can directly be `eval`ed. a scriptlet that can directly be `eval`ed.
--points-at <object>:: --points-at=<object>::
Only list refs which points at the given object. Only list refs which points at the given object.
--merged [<object>]:: --merged[=<object>]::
Only list refs whose tips are reachable from the Only list refs whose tips are reachable from the
specified commit (HEAD if not specified), specified commit (HEAD if not specified),
incompatible with `--no-merged`. incompatible with `--no-merged`.
--no-merged [<object>]:: --no-merged[=<object>]::
Only list refs whose tips are not reachable from the Only list refs whose tips are not reachable from the
specified commit (HEAD if not specified), specified commit (HEAD if not specified),
incompatible with `--merged`. incompatible with `--merged`.
--contains [<object>]:: --contains[=<object>]::
Only list refs which contain the specified commit (HEAD if not Only list refs which contain the specified commit (HEAD if not
specified). specified).
--no-contains [<object>]:: --no-contains[=<object>]::
Only list refs which don't contain the specified commit (HEAD Only list refs which don't contain the specified commit (HEAD
if not specified). if not specified).