1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>git-for-each-ref(
1)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
478 function tocEntries(el
, toclevels
) {
479 var result
= new Array
;
480 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
484 var iterate = function (el
) {
485 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
486 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
487 var mo
= re
.exec(i
.tagName
);
488 if (mo
&& (i
.getAttribute("class") || i
.getAttribute("className")) != "float") {
489 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
499 var toc
= document
.getElementById("toc");
500 var entries
= tocEntries(document
.getElementById("content"), toclevels
);
501 for (var i
= 0; i
< entries
.length
; ++i
) {
502 var entry
= entries
[i
];
503 if (entry
.element
.id
== "")
504 entry
.element
.id
= "_toc_" + i
;
505 var a
= document
.createElement("a");
506 a
.href
= "#" + entry
.element
.id
;
507 a
.appendChild(document
.createTextNode(entry
.text
));
508 var div
= document
.createElement("div");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note
= spans
[i
].innerHTML
.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder
.innerHTML
+=
539 "<div class='footnote' id='_footnote_" + n
+ "'>" +
540 "<a href='#_footnoteref_" + n
+ "' title='Return to text'>" +
541 n
+ "</a>. " + note
+ "</div>";
543 "[<a id='_footnoteref_" + n
+ "' href='#_footnote_" + n
+
544 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
545 var id
=spans
[i
].getAttribute("id");
546 if (id
!= null) refs
["#"+id
] = n
;
550 noteholder
.parentNode
.removeChild(noteholder
);
552 // Process footnoterefs.
553 for (i
=0; i
<spans
.length
; i
++) {
554 if (spans
[i
].className
== "footnoteref") {
555 var href
= spans
[i
].getElementsByTagName("a")[0].getAttribute("href");
556 href
= href
.match(/#.*/)[0]; // Because IE return full URL.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 git-for-each-ref(
1) Manual Page
576 <div class=
"sectionbody">
577 <p>git-for-each-ref -
578 Output information on each ref
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git for-each-ref
</em> [--count=
<count
>] [--shell|--perl|--python|--tcl]
587 [(--sort=
<key
>)
…] [--format=
<format
>] [
<pattern
>…]
</div>
588 <div class=
"verseblock-attribution">
591 <h2 id=
"_description">DESCRIPTION
</h2>
592 <div class=
"sectionbody">
593 <div class=
"paragraph"><p>Iterate over all refs that match
<tt><pattern
></tt> and show them
594 according to the given
<tt><format
></tt>, after sorting them according
595 to the given set of
<tt><key
></tt>. If
<tt><count
></tt> is given, stop after
596 showing that many refs. The interpolated values in
<tt><format
></tt>
597 can optionally be quoted as string literals in the specified
598 host language allowing their direct evaluation in that language.
</p></div>
600 <h2 id=
"_options">OPTIONS
</h2>
601 <div class=
"sectionbody">
602 <div class=
"dlist"><dl>
608 By default the command shows all refs that match
609 <tt><pattern
></tt>. This option makes it stop after showing
618 A field name to sort on. Prefix
<tt>-
</tt> to sort in
619 descending order of the value. When unspecified,
620 <tt>refname
</tt> is used. You may use the --sort=
<key
> option
621 multiple times, in which case the last key becomes the primary
630 A string that interpolates
<tt>%(fieldname)
</tt> from the
631 object pointed at by a ref being shown. If
<tt>fieldname
</tt>
632 is prefixed with an asterisk (
<tt>*
</tt>) and the ref points
633 at a tag object, the value for the field in the object
634 tag refers is used. When unspecified, defaults to
635 <tt>%(objectname) SPC %(objecttype) TAB %(refname)
</tt>.
636 It also interpolates
<tt>%%
</tt> to
<tt>%
</tt>, and
<tt>%xx
</tt> where
<tt>xx
</tt>
637 are hex digits interpolates to character with hex code
638 <tt>xx
</tt>; for example
<tt>%
00</tt> interpolates to
<tt>\
0</tt> (NUL),
639 <tt>%
09</tt> to
<tt>\t
</tt> (TAB) and
<tt>%
0a
</tt> to
<tt>\n
</tt> (LF).
643 <pattern
>…
647 If one or more patterns are given, only refs are shown that
648 match against at least one pattern, either using fnmatch(
3) or
649 literally, in the latter case matching completely or from the
650 beginning up to a slash.
667 If given, strings that substitute
<tt>%(fieldname)
</tt>
668 placeholders are quoted as string literals suitable for
669 the specified host language. This is meant to produce
670 a scriptlet that can directly be `eval`ed.
675 <h2 id=
"_field_names">FIELD NAMES
</h2>
676 <div class=
"sectionbody">
677 <div class=
"paragraph"><p>Various values from structured fields in referenced objects can
678 be used to interpolate into the resulting output, or as sort
680 <div class=
"paragraph"><p>For all objects, the following names can be used:
</p></div>
681 <div class=
"dlist"><dl>
687 The name of the ref (the part after $GIT_DIR/).
688 For a non-ambiguous short name of the ref append
<tt>:short
</tt>.
689 The option core.warnAmbiguousRefs is used to select the strict
698 The type of the object (
<tt>blob
</tt>,
<tt>tree
</tt>,
<tt>commit
</tt>,
<tt>tag
</tt>).
706 The size of the object (the same as
<em>git cat-file -s
</em> reports).
714 The object name (aka SHA-
1).
715 For a non-ambiguous abbreviation of the object name append
<tt>:short
</tt>.
723 The name of a local ref which can be considered
“upstream
”
724 from the displayed ref. Respects
<tt>:short
</tt> in the same way as
725 <tt>refname
</tt> above.
729 <div class=
"paragraph"><p>In addition to the above, for commit and tag objects, the header
730 field names (
<tt>tree
</tt>,
<tt>parent
</tt>,
<tt>object
</tt>,
<tt>type
</tt>, and
<tt>tag
</tt>) can
731 be used to specify the value in the header field.
</p></div>
732 <div class=
"paragraph"><p>Fields that have name-email-date tuple as its value (
<tt>author
</tt>,
733 <tt>committer
</tt>, and
<tt>tagger
</tt>) can be suffixed with
<tt>name
</tt>,
<tt>email
</tt>,
734 and
<tt>date
</tt> to extract the named component.
</p></div>
735 <div class=
"paragraph"><p>The first line of the message in a commit and tag object is
736 <tt>subject
</tt>, the remaining lines are
<tt>body
</tt>. The whole message
737 is
<tt>contents
</tt>.
</p></div>
738 <div class=
"paragraph"><p>For sorting purposes, fields with numeric values sort in numeric
739 order (
<tt>objectsize
</tt>,
<tt>authordate
</tt>,
<tt>committerdate
</tt>,
<tt>taggerdate
</tt>).
740 All other fields are used to sort in their byte-value order.
</p></div>
741 <div class=
"paragraph"><p>In any case, a field name that refers to a field inapplicable to
742 the object referred by the ref does not cause an error. It
743 returns an empty string instead.
</p></div>
744 <div class=
"paragraph"><p>As a special case for the date-type fields, you may specify a format for
745 the date by adding one of
<tt>:default
</tt>,
<tt>:relative
</tt>,
<tt>:short
</tt>,
<tt>:local
</tt>,
746 <tt>:iso8601
</tt> or
<tt>:rfc2822
</tt> to the end of the fieldname; e.g.
747 <tt>%(taggerdate:relative)
</tt>.
</p></div>
749 <h2 id=
"_examples">EXAMPLES
</h2>
750 <div class=
"sectionbody">
751 <div class=
"paragraph"><p>An example directly producing formatted text. Show the most recent
752 3 tagged commits:
</p></div>
753 <div class=
"listingblock">
754 <div class=
"content">
757 git for-each-ref --count=
3 --sort='-*authordate' \
758 --format='From: %(*authorname) %(*authoremail)
764 ' 'refs/tags'
</tt></pre>
766 <div class=
"paragraph"><p>A simple example showing the use of shell eval on the output,
767 demonstrating the use of --shell. List the prefixes of all heads:
</p></div>
768 <div class=
"listingblock">
769 <div class=
"content">
772 git for-each-ref --shell
--format=
"ref=%(refname)" refs/heads | \
779 <div class=
"paragraph"><p>A bit more elaborate report on tags, demonstrating that the format
780 may be an entire script:
</p></div>
781 <div class=
"listingblock">
782 <div class=
"content">
800 # could be a lightweight tag
802 kind=
"Lightweight tag"
810 echo
"$kind $T points at a $t object $o"
811 if test
"z$t" = zcommit
813 echo
"The commit was authored by $n $e
818 Its message reads as:
820 echo
"$b" | sed -e
"s/^/ /"
825 eval=`git for-each-ref --shell
--format=
"$fmt" \
826 --sort='*objecttype' \
829 eval
"$eval"</tt></pre>
832 <h2 id=
"_author">Author
</h2>
833 <div class=
"sectionbody">
834 <div class=
"paragraph"><p>Written by Junio C Hamano
<<a href=
"mailto:gitster@pobox.com">gitster@pobox.com
</a>>.
</p></div>
836 <h2 id=
"_documentation">Documentation
</h2>
837 <div class=
"sectionbody">
838 <div class=
"paragraph"><p>Documentation by Junio C Hamano and the git-list
<<a href=
"mailto:git@vger.kernel.org">git@vger.kernel.org
</a>>.
</p></div>
840 <h2 id=
"_git">GIT
</h2>
841 <div class=
"sectionbody">
842 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
845 <div id=
"footnotes"><hr /></div>
847 <div id=
"footer-text">
848 Last updated
2011-
09-
21 23:
01:
14 PDT