X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fgit-for-each-ref.txt;h=5061d3e4e7b8a888093c5e8c7b4cb03509391756;hb=7e425c4fbbe9affffa822f154d8bb2d0da6699ef;hp=b347bfbb14784a4292124a4575086411a4697527;hpb=196821f440d46029f0399a7d97c0cfc78a870244;p=git.git diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index b347bfbb1..5061d3e4e 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -8,7 +8,7 @@ git-for-each-ref - Output information on each ref SYNOPSIS -------- [verse] -'git-for-each-ref' [--count=] [--shell|--perl|--python|--tcl] +'git for-each-ref' [--count=] [--shell|--perl|--python|--tcl] [--sort=]\* [--format=] [...] DESCRIPTION @@ -16,7 +16,7 @@ DESCRIPTION Iterate over all refs that match `` and show them according to the given ``, after sorting them according -to the given set of ``. If `` is given, stop after +to the given set of ``. If `` is given, stop after showing that many refs. The interpolated values in `` can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language. @@ -47,9 +47,9 @@ OPTIONS `xx`; for example `%00` interpolates to `\0` (NUL), `%09` to `\t` (TAB) and `%0a` to `\n` (LF). -:: +...:: If one or more patterns are given, only refs are shown that - match againt at least one pattern, either using fnmatch(3) or + 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. @@ -74,12 +74,13 @@ For all objects, the following names can be used: refname:: The name of the ref (the part after $GIT_DIR/). + For a non-ambiguous short name of the ref append `:short`. objecttype:: The type of the object (`blob`, `tree`, `commit`, `tag`). objectsize:: - The size of the object (the same as `git-cat-file -s` reports). + The size of the object (the same as 'git-cat-file -s' reports). objectname:: The object name (aka SHA-1). @@ -119,7 +120,7 @@ An example directly producing formatted text. Show the most recent ------------ #!/bin/sh -git-for-each-ref --count=3 --sort='-*authordate' \ +git for-each-ref --count=3 --sort='-*authordate' \ --format='From: %(*authorname) %(*authoremail) Subject: %(*subject) Date: %(*authordate) @@ -135,7 +136,7 @@ demonstrating the use of --shell. List the prefixes of all heads:: ------------ #!/bin/sh -git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \ +git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ while read entry do eval "$entry" @@ -189,7 +190,7 @@ Its message reads as: fi ' -eval=`git-for-each-ref --shell --format="$fmt" \ +eval=`git for-each-ref --shell --format="$fmt" \ --sort='*objecttype' \ --sort=-taggerdate \ refs/tags`