git-for-each-ref(1)

DESCRIPTION

@@ -329,6 +329,32 @@ ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output

+-f, --show-name +

+ Show filename in the original commit. By default + filename is shown if there is any line that came from a + file with different name, due to rename detection. +

+-n, --show-number +

+ Show line number in the original commit (Default: off). +

+-p, --porcelain +

+ Show in a format designed for machine consumption. +

-h, --help

@@ -338,6 +364,59 @@ ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output

THE PORCELAIN FORMAT

In this format, each line is output after a header; the +header at the minumum has the first line which has:

+
+40-byte SHA-1 of the commit the line is attributed to; +
+
+
+the line number of the line in the original file; +
+
+
+the line number of the line in the final file; +
+
+
+on a line that starts a group of line from a different + commit than the previous one, the number of lines in this + group. On subsequent lines this field is absent. +
+

This header line is followed by the following information +at least once for each commit:

+
+author name ("author"), email ("author-mail"), time + ("author-time"), and timezone ("author-tz"); similarly + for committer. +
+
+
+filename in the commit the line is attributed to. +
+
+
+the first line of the commit log message ("summary"). +
+

The contents of the actual line is output after the above +header, prefixed by a TAB. This is to allow adding more +header elements later.

SEE ALSO

git-annotate(1)

@@ -352,7 +431,7 @@ ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output

] [--] [] +'git-blame' [-c] [-l] [-t] [-f] [-n] [-p] [-S ] [--] [] DESCRIPTION ----------- @@ -45,10 +45,47 @@ OPTIONS -S, --rev-file :: Use revs from revs-file instead of calling gitlink:git-rev-list[1]. +-f, --show-name:: + Show filename in the original commit. By default + filename is shown if there is any line that came from a + file with different name, due to rename detection. + +-n, --show-number:: + Show line number in the original commit (Default: off). + +-p, --porcelain:: + Show in a format designed for machine consumption. + -h, --help:: Show help message. +THE PORCELAIN FORMAT +-------------------- + +In this format, each line is output after a header; the +header at the minumum has the first line which has: + +- 40-byte SHA-1 of the commit the line is attributed to; +- the line number of the line in the original file; +- the line number of the line in the final file; +- on a line that starts a group of line from a different + commit than the previous one, the number of lines in this + group. On subsequent lines this field is absent. + +This header line is followed by the following information +at least once for each commit: + +- author name ("author"), email ("author-mail"), time + ("author-time"), and timezone ("author-tz"); similarly + for committer. +- filename in the commit the line is attributed to. +- the first line of the commit log message ("summary"). + +The contents of the actual line is output after the above +header, prefixed by a TAB. This is to allow adding more +header elements later. + SEE ALSO -------- gitlink:git-annotate[1] diff --git a/git-cherry.html b/git-cherry.html index 559f8c505..cec73bfc7 100644 --- a/git-cherry.html +++ b/git-cherry.html @@ -278,8 +278,9 @@ git-cherry(1) Manual Page

The changeset (or "diff") of each commit between the fork-point and <head> is compared against each commit between the fork-point and <upstream>.

Every commit with a changeset that doesn't exist in the other branch -has its id (sha1) reported, prefixed by a symbol. Those existing only +

Every commit that doesn't exist in the <upstream> branch +has its id (sha1) reported, prefixed by a symbol. The ones that have +equivalent change already in the <upstream> branch are prefixed with a minus (-) sign, and those that only exist in the <head> branch are prefixed with a plus (+) symbol.

Because git-cherry compares the changeset rather than the commit id @@ -331,7 +332,7 @@ than pushing or pulling commits directly.

diff --git a/git-cherry.txt b/git-cherry.txt index 893baaa6f..e1bf8ee25 100644 --- a/git-cherry.txt +++ b/git-cherry.txt @@ -14,8 +14,9 @@ DESCRIPTION The changeset (or "diff") of each commit between the fork-point and is compared against each commit between the fork-point and . -Every commit with a changeset that doesn't exist in the other branch -has its id (sha1) reported, prefixed by a symbol. Those existing only +Every commit that doesn't exist in the branch +has its id (sha1) reported, prefixed by a symbol. The ones that have +equivalent change already in the branch are prefixed with a minus (-) sign, and those that only exist in the branch are prefixed with a plus (+) symbol. diff --git a/git-for-each-ref.html b/git-for-each-ref.html new file mode 100644 index 000000000..3c4ee272b --- /dev/null +++ b/git-for-each-ref.html @@ -0,0 +1,491 @@ + + + + + + +git-for-each-ref(1) + + + +

SYNOPSIS

git-for-each-ref [--count=<count>] [--shell|--perl|--python] [--sort=<key>] [--format=<format>] [<pattern>]

DESCRIPTION

Iterate over all refs that match <pattern> and show them +according to the given <format>, after sorting them according +to the given set of <key>`s. If <max>is given, stop after +showing that many refs. The interporated values in<format>` +can optionally be quoted as string literals in the specified +host language allowing their direct evaluation in that language.

OPTIONS

+<count> +: +
+ By default the command shows all refs that match + <pattern>. This option makes it stop after showing + that many refs. +
+
+<key> +: +
+ A field name to sort on. Prefix - to sort in + descending order of the value. When unspecified, + refname is used. More than one sort keys can be + given. +
+
+<format> +: +
+ A string that interpolates %(fieldname) from the + object pointed at by a ref being shown. If fieldname + is prefixed with an asterisk (*) and the ref points + at a tag object, the value for the field in the object + tag refers is used. When unspecified, defaults to + %(refname). +
+
+<pattern> +: +
+ If given, the name of the ref is matched against this + using fnmatch(3). Refs that do not match the pattern + are not shown. +
+
+--shell, --perl, --python +: +
+ If given, strings that substitute %(fieldname) + placeholders are quoted as string literals suitable for + the specified host language. This is meant to produce + a scriptlet that can directly be `eval`ed. +
+

FIELD NAMES

Various values from structured fields in referenced objects can +be used to interpolate into the resulting output, or as sort +keys.

For all objects, the following names can be used:

+refname +: +
+ The name of the ref (the part after $GIT_DIR/refs/). +
+
+objecttype +: +
+ The type of the object (blob, tree, commit, tag). +
+
+objectsize +: +
+ The size of the object (the same as git-cat-file -s reports). +
+
+objectname +: +
+ The object name (aka SHA-1). +
+

In addition to the above, for commit and tag objects, the header +field names (tree, parent, object, type, and tag) can +be used to specify the value in the header field.

Fields that have name-email-date tuple as its value (author, +committer, and tagger) can be suffixed with name, email, +and date to extract the named component.

The first line of the message in a commit and tag object is +subject, the remaining lines are body. The whole message +is contents.

For sorting purposes, fields with numeric values sort in numeric +order (objectsize, authordate, committerdate, taggerdate). +All other fields are used to sort in their byte-value order.

In any case, a field name that refers to a field inapplicable to +the object referred by the ref does not cause an error. It +returns an empty string instead.

EXAMPLES

An example directly producing formatted text. Show the most recent +3 tagged commits::

#!/bin/sh
+
+git-for-each-ref --count=3 --sort='-*authordate' \
+--format='From: %(*authorname) %(*authoremail)
+Subject: %(*subject)
+Date: %(*authordate)
+Ref: %(*refname)
+
+%(*body)
+' 'refs/tags'

A simple example showing the use of shell eval on the output, +demonstrating the use of --shell. List the prefixes of all heads::

#!/bin/sh
+
+git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \
+while read entry
+do
+        eval "$entry"
+        echo `dirname $ref`
+done

A bit more elaborate report on tags, demonstrating that the format +may be an entire script::

#!/bin/sh
+
+fmt='
+        r=%(refname)
+        t=%(*objecttype)
+        T=${r#refs/tags/}
+
+        o=%(*objectname)
+        n=%(*authorname)
+        e=%(*authoremail)
+        s=%(*subject)
+        d=%(*authordate)
+        b=%(*body)
+
+        kind=Tag
+        if test "z$t" = z
+        then
+                # could be a lightweight tag
+                t=%(objecttype)
+                kind="Lightweight tag"
+                o=%(objectname)
+                n=%(authorname)
+                e=%(authoremail)
+                s=%(subject)
+                d=%(authordate)
+                b=%(body)
+        fi
+        echo "$kind $T points at a $t object $o"
+        if test "z$t" = zcommit
+        then
+                echo "The commit was authored by $n $e
+at $d, and titled
+
+    $s
+
+Its message reads as:
+"
+                echo "$b" | sed -e "s/^/    /"
+                echo
+        fi
+'
+
+eval=`git-for-each-ref --shell --format="$fmt" \
+        --sort='*objecttype' \
+        --sort=-taggerdate \
+        refs/tags`
+eval "$eval"

+ + + diff --git a/git-for-each-ref.txt b/git-for-each-ref.txt new file mode 100644 index 000000000..d5fdcef8d --- /dev/null +++ b/git-for-each-ref.txt @@ -0,0 +1,181 @@ +git-for-each-ref(1) +=================== + +NAME +---- +git-for-each-ref - Output information on each ref + +SYNOPSIS +-------- +'git-for-each-ref' [--count=]* [--shell|--perl|--python] [--sort=]* [--format=] [] + +DESCRIPTION +----------- + +Iterate over all refs that match `` and show them +according to the given ``, after sorting them according +to the given set of ``s. If `` is given, stop after +showing that many refs. The interporated values in `` +can optionally be quoted as string literals in the specified +host language allowing their direct evaluation in that language. + +OPTIONS +------- +:: + By default the command shows all refs that match + ``. This option makes it stop after showing + that many refs. + +:: + A field name to sort on. Prefix `-` to sort in + descending order of the value. When unspecified, + `refname` is used. More than one sort keys can be + given. + +:: + A string that interpolates `%(fieldname)` from the + object pointed at by a ref being shown. If `fieldname` + is prefixed with an asterisk (`*`) and the ref points + at a tag object, the value for the field in the object + tag refers is used. When unspecified, defaults to + `%(refname)`. + +:: + If given, the name of the ref is matched against this + using fnmatch(3). Refs that do not match the pattern + are not shown. + +--shell, --perl, --python:: + If given, strings that substitute `%(fieldname)` + placeholders are quoted as string literals suitable for + the specified host language. This is meant to produce + a scriptlet that can directly be `eval`ed. + + +FIELD NAMES +----------- + +Various values from structured fields in referenced objects can +be used to interpolate into the resulting output, or as sort +keys. + +For all objects, the following names can be used: + +refname:: + The name of the ref (the part after $GIT_DIR/refs/). + +objecttype:: + The type of the object (`blob`, `tree`, `commit`, `tag`). + +objectsize:: + The size of the object (the same as `git-cat-file -s` reports). + +objectname:: + The object name (aka SHA-1). + +In addition to the above, for commit and tag objects, the header +field names (`tree`, `parent`, `object`, `type`, and `tag`) can +be used to specify the value in the header field. + +Fields that have name-email-date tuple as its value (`author`, +`committer`, and `tagger`) can be suffixed with `name`, `email`, +and `date` to extract the named component. + +The first line of the message in a commit and tag object is +`subject`, the remaining lines are `body`. The whole message +is `contents`. + +For sorting purposes, fields with numeric values sort in numeric +order (`objectsize`, `authordate`, `committerdate`, `taggerdate`). +All other fields are used to sort in their byte-value order. + +In any case, a field name that refers to a field inapplicable to +the object referred by the ref does not cause an error. It +returns an empty string instead. + + +EXAMPLES +-------- + +An example directly producing formatted text. Show the most recent +3 tagged commits:: + +------------ +#!/bin/sh + +git-for-each-ref --count=3 --sort='-*authordate' \ +--format='From: %(*authorname) %(*authoremail) +Subject: %(*subject) +Date: %(*authordate) +Ref: %(*refname) + +%(*body) +' 'refs/tags' +------------ + + +A simple example showing the use of shell eval on the output, +demonstrating the use of --shell. List the prefixes of all heads:: +------------ +#!/bin/sh + +git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \ +while read entry +do + eval "$entry" + echo `dirname $ref` +done +------------ + + +A bit more elaborate report on tags, demonstrating that the format +may be an entire script:: +------------ +#!/bin/sh + +fmt=' + r=%(refname) + t=%(*objecttype) + T=${r#refs/tags/} + + o=%(*objectname) + n=%(*authorname) + e=%(*authoremail) + s=%(*subject) + d=%(*authordate) + b=%(*body) + + kind=Tag + if test "z$t" = z + then + # could be a lightweight tag + t=%(objecttype) + kind="Lightweight tag" + o=%(objectname) + n=%(authorname) + e=%(authoremail) + s=%(subject) + d=%(authordate) + b=%(body) + fi + echo "$kind $T points at a $t object $o" + if test "z$t" = zcommit + then + echo "The commit was authored by $n $e +at $d, and titled + + $s + +Its message reads as: +" + echo "$b" | sed -e "s/^/ /" + echo + fi +' + +eval=`git-for-each-ref --shell --format="$fmt" \ + --sort='*objecttype' \ + --sort=-taggerdate \ + refs/tags` +eval "$eval" +------------ diff --git a/git.html b/git.html index 0f1b97238..757b07c39 100644 --- a/git.html +++ b/git.html @@ -1491,6 +1491,8 @@ HEAD

For a more complete list of ways to spell object names, see +"SPECIFYING REVISIONS" section in git-rev-parse(1).

File/Directory Structure

@@ -2180,7 +2182,7 @@ contributors on the git-list <git@vger.kernel.org>.

diff --git a/git.txt b/git.txt index 3af6fc63e..b00607ee1 100644 --- a/git.txt +++ b/git.txt @@ -562,6 +562,9 @@ HEAD:: a valid head 'name' (i.e. the contents of `$GIT_DIR/refs/heads/`). +For a more complete list of ways to spell object names, see +"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + File/Directory Structure ------------------------ -- 2.26.2

SYNOPSIS

DESCRIPTION

THE PORCELAIN FORMAT

SEE ALSO

+git-for-each-ref(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

FIELD NAMES

EXAMPLES

File/Directory Structure