diff options
| author | Junio C Hamano <junio@hera.kernel.org> | 2006-10-25 22:55:31 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@hera.kernel.org> | 2006-10-25 22:55:31 +0000 |
| commit | ff4b4317784217ee2620caf2cd06b3d4b6b00a9a (patch) | |
| tree | fe258b15e72bbf6e1a04624ab94052e6f39c00c0 /git-for-each-ref.html | |
| parent | 249572f7c8a246cc1bb6c31a30d599f85bb10cb9 (diff) | |
| download | git-htmldocs-ff4b4317784217ee2620caf2cd06b3d4b6b00a9a.tar.gz | |
Autogenerated HTML docs for v1.4.3.3-geb15
Diffstat (limited to 'git-for-each-ref.html')
| -rw-r--r-- | git-for-each-ref.html | 491 |
1 files changed, 491 insertions, 0 deletions
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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 7.0.2" />
+<style type="text/css">
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+ border: 1px solid red;
+*/
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a { color: blue; }
+a:visited { color: fuchsia; }
+
+em {
+ font-style: italic;
+}
+
+strong {
+ font-weight: bold;
+}
+
+tt {
+ color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ font-family: sans-serif;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-bottom: 2px solid silver;
+ padding-top: 0.5em;
+}
+
+div.sectionbody {
+ font-family: serif;
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+span#email {
+}
+span#revision {
+ font-family: sans-serif;
+}
+
+div#footer {
+ font-family: sans-serif;
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble,
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-right: 10%;
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.5em;
+ margin-bottom: 2.5em;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ font-family: sans-serif;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock > div.content {
+ padding-left: 2.0em;
+}
+div.quoteblock .attribution {
+ text-align: right;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 2px solid silver;
+}
+
+div.exampleblock > div.content {
+ border-left: 2px solid silver;
+ padding: 0.5em;
+}
+
+div.verseblock div.content {
+ white-space: pre;
+}
+
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: italic;
+}
+dd > *:first-child {
+ margin-top: 0;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.olist2 {
+ list-style-type: lower-alpha;
+}
+
+div.tableblock > table {
+ border-color: #527bbd;
+ border-width: 3px;
+}
+thead {
+ font-family: sans-serif;
+ font-weight: bold;
+}
+tfoot {
+ font-weight: bold;
+}
+
+div.hlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+td.hlist1 {
+ vertical-align: top;
+ font-style: italic;
+ padding-right: 0.8em;
+}
+td.hlist2 {
+ vertical-align: top;
+}
+
+@media print {
+ div#footer-badges { display: none; }
+}
+include::./stylesheets/xhtml11-manpage.css[]
+/* Workarounds for IE6's broken and incomplete CSS2. */
+
+div.sidebar-content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 0.0em;
+ margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock-content {
+ padding-left: 2.0em;
+}
+
+div.exampleblock-content {
+ border-left: 2px solid silver;
+ padding-left: 0.5em;
+}
+</style>
+<title>git-for-each-ref(1)</title>
+</head>
+<body>
+<div id="header">
+<h1>
+git-for-each-ref(1) Manual Page
+</h1>
+<h2>NAME</h2>
+<div class="sectionbody">
+<p>git-for-each-ref -
+ Output information on each ref
+</p>
+</div>
+</div>
+<h2>SYNOPSIS</h2>
+<div class="sectionbody">
+<p><em>git-for-each-ref</em> [--count=<count>]<strong> [--shell|--perl|--python] [--sort=<key>]</strong> [--format=<format>] [<pattern>]</p>
+</div>
+<h2>DESCRIPTION</h2>
+<div class="sectionbody">
+<p>Iterate over all refs that match <tt><pattern></tt> and show them
+according to the given <tt><format></tt>, after sorting them according
+to the given set of <tt><key>`s. If </tt><max><tt> is given, stop after
+showing that many refs. The interporated values in </tt><format>`
+can optionally be quoted as string literals in the specified
+host language allowing their direct evaluation in that language.</p>
+</div>
+<h2>OPTIONS</h2>
+<div class="sectionbody">
+<dl>
+<dt>
+<count>
+</dt>
+<dd>
+<p>
+ By default the command shows all refs that match
+ <tt><pattern></tt>. This option makes it stop after showing
+ that many refs.
+</p>
+</dd>
+<dt>
+<key>
+</dt>
+<dd>
+<p>
+ A field name to sort on. Prefix <tt>-</tt> to sort in
+ descending order of the value. When unspecified,
+ <tt>refname</tt> is used. More than one sort keys can be
+ given.
+</p>
+</dd>
+<dt>
+<format>
+</dt>
+<dd>
+<p>
+ A string that interpolates <tt>%(fieldname)</tt> from the
+ object pointed at by a ref being shown. If <tt>fieldname</tt>
+ is prefixed with an asterisk (<tt>*</tt>) and the ref points
+ at a tag object, the value for the field in the object
+ tag refers is used. When unspecified, defaults to
+ <tt>%(refname)</tt>.
+</p>
+</dd>
+<dt>
+<pattern>
+</dt>
+<dd>
+<p>
+ If given, the name of the ref is matched against this
+ using fnmatch(3). Refs that do not match the pattern
+ are not shown.
+</p>
+</dd>
+<dt>
+--shell, --perl, --python
+</dt>
+<dd>
+<p>
+ If given, strings that substitute <tt>%(fieldname)</tt>
+ 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.
+</p>
+</dd>
+</dl>
+</div>
+<h2>FIELD NAMES</h2>
+<div class="sectionbody">
+<p>Various values from structured fields in referenced objects can
+be used to interpolate into the resulting output, or as sort
+keys.</p>
+<p>For all objects, the following names can be used:</p>
+<dl>
+<dt>
+refname
+</dt>
+<dd>
+<p>
+ The name of the ref (the part after $GIT_DIR/refs/).
+</p>
+</dd>
+<dt>
+objecttype
+</dt>
+<dd>
+<p>
+ The type of the object (<tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, <tt>tag</tt>).
+</p>
+</dd>
+<dt>
+objectsize
+</dt>
+<dd>
+<p>
+ The size of the object (the same as <tt>git-cat-file -s</tt> reports).
+</p>
+</dd>
+<dt>
+objectname
+</dt>
+<dd>
+<p>
+ The object name (aka SHA-1).
+</p>
+</dd>
+</dl>
+<p>In addition to the above, for commit and tag objects, the header
+field names (<tt>tree</tt>, <tt>parent</tt>, <tt>object</tt>, <tt>type</tt>, and <tt>tag</tt>) can
+be used to specify the value in the header field.</p>
+<p>Fields that have name-email-date tuple as its value (<tt>author</tt>,
+<tt>committer</tt>, and <tt>tagger</tt>) can be suffixed with <tt>name</tt>, <tt>email</tt>,
+and <tt>date</tt> to extract the named component.</p>
+<p>The first line of the message in a commit and tag object is
+<tt>subject</tt>, the remaining lines are <tt>body</tt>. The whole message
+is <tt>contents</tt>.</p>
+<p>For sorting purposes, fields with numeric values sort in numeric
+order (<tt>objectsize</tt>, <tt>authordate</tt>, <tt>committerdate</tt>, <tt>taggerdate</tt>).
+All other fields are used to sort in their byte-value order.</p>
+<p>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.</p>
+</div>
+<h2>EXAMPLES</h2>
+<div class="sectionbody">
+<p>An example directly producing formatted text. Show the most recent
+3 tagged commits::</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>#!/bin/sh
+
+git-for-each-ref --count=3 --sort='-*authordate' \
+--format='From: %(*authorname) %(*authoremail)
+Subject: %(*subject)
+Date: %(*authordate)
+Ref: %(*refname)
+
+%(*body)
+' 'refs/tags'</tt></pre>
+</div></div>
+<p>A simple example showing the use of shell eval on the output,
+demonstrating the use of --shell. List the prefixes of all heads::</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>#!/bin/sh
+
+git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \
+while read entry
+do
+ eval "$entry"
+ echo `dirname $ref`
+done</tt></pre>
+</div></div>
+<p>A bit more elaborate report on tags, demonstrating that the format
+may be an entire script::</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>#!/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"</tt></pre>
+</div></div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 25-Oct-2006 22:55:22 UTC
+</div>
+</div>
+</body>
+</html>
|