1571 lines
46 KiB
HTML
1571 lines
46 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!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="application/xhtml+xml; charset=UTF-8" />
|
|
<meta name="generator" content="AsciiDoc 10.2.0" />
|
|
<title>git-for-each-ref(1)</title>
|
|
<style type="text/css">
|
|
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
|
|
|
/* Default font. */
|
|
body {
|
|
font-family: Georgia,serif;
|
|
}
|
|
|
|
/* Title font. */
|
|
h1, h2, h3, h4, h5, h6,
|
|
div.title, caption.title,
|
|
thead, p.table.header,
|
|
#toctitle,
|
|
#author, #revnumber, #revdate, #revremark,
|
|
#footer {
|
|
font-family: Arial,Helvetica,sans-serif;
|
|
}
|
|
|
|
body {
|
|
margin: 1em 5% 1em 5%;
|
|
}
|
|
|
|
a {
|
|
color: blue;
|
|
text-decoration: underline;
|
|
}
|
|
a:visited {
|
|
color: fuchsia;
|
|
}
|
|
|
|
em {
|
|
font-style: italic;
|
|
color: navy;
|
|
}
|
|
|
|
strong {
|
|
font-weight: bold;
|
|
color: #083194;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5, h6 {
|
|
color: #527bbd;
|
|
margin-top: 1.2em;
|
|
margin-bottom: 0.5em;
|
|
line-height: 1.3;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
padding-top: 0.5em;
|
|
}
|
|
h3 {
|
|
float: left;
|
|
}
|
|
h3 + * {
|
|
clear: left;
|
|
}
|
|
h5 {
|
|
font-size: 1.0em;
|
|
}
|
|
|
|
div.sectionbody {
|
|
margin-left: 0;
|
|
}
|
|
|
|
hr {
|
|
border: 1px solid silver;
|
|
}
|
|
|
|
p {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
ul, ol, li > p {
|
|
margin-top: 0;
|
|
}
|
|
ul > li { color: #aaa; }
|
|
ul > li > * { color: black; }
|
|
|
|
.monospaced, code, pre {
|
|
font-family: "Courier New", Courier, monospace;
|
|
font-size: inherit;
|
|
color: navy;
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
pre {
|
|
white-space: pre-wrap;
|
|
}
|
|
|
|
#author {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
#email {
|
|
}
|
|
#revnumber, #revdate, #revremark {
|
|
}
|
|
|
|
#footer {
|
|
font-size: small;
|
|
border-top: 2px solid silver;
|
|
padding-top: 0.5em;
|
|
margin-top: 4.0em;
|
|
}
|
|
#footer-text {
|
|
float: left;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
#footer-badges {
|
|
float: right;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
|
|
#preamble {
|
|
margin-top: 1.5em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.imageblock, div.exampleblock, div.verseblock,
|
|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
div.admonitionblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.admonitionblock {
|
|
margin-top: 2.0em;
|
|
margin-bottom: 2.0em;
|
|
margin-right: 10%;
|
|
color: #606060;
|
|
}
|
|
|
|
div.content { /* Block element content. */
|
|
padding: 0;
|
|
}
|
|
|
|
/* Block element titles. */
|
|
div.title, caption.title {
|
|
color: #527bbd;
|
|
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 #dddddd;
|
|
border-left: 4px solid #f0f0f0;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.listingblock > div.content {
|
|
border: 1px solid #dddddd;
|
|
border-left: 5px solid #f0f0f0;
|
|
background: #f8f8f8;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.quoteblock, div.verseblock {
|
|
padding-left: 1.0em;
|
|
margin-left: 1.0em;
|
|
margin-right: 10%;
|
|
border-left: 5px solid #f0f0f0;
|
|
color: #888;
|
|
}
|
|
|
|
div.quoteblock > div.attribution {
|
|
padding-top: 0.5em;
|
|
text-align: right;
|
|
}
|
|
|
|
div.verseblock > pre.content {
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
}
|
|
div.verseblock > div.attribution {
|
|
padding-top: 0.75em;
|
|
text-align: left;
|
|
}
|
|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
div.verseblock + div.attribution {
|
|
text-align: left;
|
|
}
|
|
|
|
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: 3px solid #dddddd;
|
|
}
|
|
|
|
div.exampleblock > div.content {
|
|
border-left: 3px solid #dddddd;
|
|
padding-left: 0.5em;
|
|
}
|
|
|
|
div.imageblock div.content { padding-left: 0; }
|
|
span.image img { border-style: none; vertical-align: text-bottom; }
|
|
a.image:visited { color: white; }
|
|
|
|
dl {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
dt {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0;
|
|
font-style: normal;
|
|
color: navy;
|
|
}
|
|
dd > *:first-child {
|
|
margin-top: 0.1em;
|
|
}
|
|
|
|
ul, ol {
|
|
list-style-position: outside;
|
|
}
|
|
ol.arabic {
|
|
list-style-type: decimal;
|
|
}
|
|
ol.loweralpha {
|
|
list-style-type: lower-alpha;
|
|
}
|
|
ol.upperalpha {
|
|
list-style-type: upper-alpha;
|
|
}
|
|
ol.lowerroman {
|
|
list-style-type: lower-roman;
|
|
}
|
|
ol.upperroman {
|
|
list-style-type: upper-roman;
|
|
}
|
|
|
|
div.compact ul, div.compact ol,
|
|
div.compact p, div.compact p,
|
|
div.compact div, div.compact div {
|
|
margin-top: 0.1em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
tfoot {
|
|
font-weight: bold;
|
|
}
|
|
td > div.verse {
|
|
white-space: pre;
|
|
}
|
|
|
|
div.hdlist {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
div.hdlist tr {
|
|
padding-bottom: 15px;
|
|
}
|
|
dt.hdlist1.strong, td.hdlist1.strong {
|
|
font-weight: bold;
|
|
}
|
|
td.hdlist1 {
|
|
vertical-align: top;
|
|
font-style: normal;
|
|
padding-right: 0.8em;
|
|
color: navy;
|
|
}
|
|
td.hdlist2 {
|
|
vertical-align: top;
|
|
}
|
|
div.hdlist.compact tr {
|
|
margin: 0;
|
|
padding-bottom: 0;
|
|
}
|
|
|
|
.comment {
|
|
background: yellow;
|
|
}
|
|
|
|
.footnote, .footnoteref {
|
|
font-size: 0.8em;
|
|
}
|
|
|
|
span.footnote, span.footnoteref {
|
|
vertical-align: super;
|
|
}
|
|
|
|
#footnotes {
|
|
margin: 20px 0 20px 0;
|
|
padding: 7px 0 0 0;
|
|
}
|
|
|
|
#footnotes div.footnote {
|
|
margin: 0 0 5px 0;
|
|
}
|
|
|
|
#footnotes hr {
|
|
border: none;
|
|
border-top: 1px solid silver;
|
|
height: 1px;
|
|
text-align: left;
|
|
margin-left: 0;
|
|
width: 20%;
|
|
min-width: 100px;
|
|
}
|
|
|
|
div.colist td {
|
|
padding-right: 0.5em;
|
|
padding-bottom: 0.3em;
|
|
vertical-align: top;
|
|
}
|
|
div.colist td img {
|
|
margin-top: 0.3em;
|
|
}
|
|
|
|
@media print {
|
|
#footer-badges { display: none; }
|
|
}
|
|
|
|
#toc {
|
|
margin-bottom: 2.5em;
|
|
}
|
|
|
|
#toctitle {
|
|
color: #527bbd;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
}
|
|
div.toclevel2 {
|
|
margin-left: 2em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel3 {
|
|
margin-left: 4em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel4 {
|
|
margin-left: 6em;
|
|
font-size: 0.9em;
|
|
}
|
|
|
|
span.aqua { color: aqua; }
|
|
span.black { color: black; }
|
|
span.blue { color: blue; }
|
|
span.fuchsia { color: fuchsia; }
|
|
span.gray { color: gray; }
|
|
span.green { color: green; }
|
|
span.lime { color: lime; }
|
|
span.maroon { color: maroon; }
|
|
span.navy { color: navy; }
|
|
span.olive { color: olive; }
|
|
span.purple { color: purple; }
|
|
span.red { color: red; }
|
|
span.silver { color: silver; }
|
|
span.teal { color: teal; }
|
|
span.white { color: white; }
|
|
span.yellow { color: yellow; }
|
|
|
|
span.aqua-background { background: aqua; }
|
|
span.black-background { background: black; }
|
|
span.blue-background { background: blue; }
|
|
span.fuchsia-background { background: fuchsia; }
|
|
span.gray-background { background: gray; }
|
|
span.green-background { background: green; }
|
|
span.lime-background { background: lime; }
|
|
span.maroon-background { background: maroon; }
|
|
span.navy-background { background: navy; }
|
|
span.olive-background { background: olive; }
|
|
span.purple-background { background: purple; }
|
|
span.red-background { background: red; }
|
|
span.silver-background { background: silver; }
|
|
span.teal-background { background: teal; }
|
|
span.white-background { background: white; }
|
|
span.yellow-background { background: yellow; }
|
|
|
|
span.big { font-size: 2em; }
|
|
span.small { font-size: 0.6em; }
|
|
|
|
span.underline { text-decoration: underline; }
|
|
span.overline { text-decoration: overline; }
|
|
span.line-through { text-decoration: line-through; }
|
|
|
|
div.unbreakable { page-break-inside: avoid; }
|
|
|
|
|
|
/*
|
|
* xhtml11 specific
|
|
*
|
|
* */
|
|
|
|
div.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.tableblock > table {
|
|
border: 3px solid #527bbd;
|
|
}
|
|
thead, p.table.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.table {
|
|
margin-top: 0;
|
|
}
|
|
/* Because the table frame attribute is overridden by CSS in most browsers. */
|
|
div.tableblock > table[frame="void"] {
|
|
border-style: none;
|
|
}
|
|
div.tableblock > table[frame="hsides"] {
|
|
border-left-style: none;
|
|
border-right-style: none;
|
|
}
|
|
div.tableblock > table[frame="vsides"] {
|
|
border-top-style: none;
|
|
border-bottom-style: none;
|
|
}
|
|
|
|
|
|
/*
|
|
* html5 specific
|
|
*
|
|
* */
|
|
|
|
table.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
thead, p.tableblock.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.tableblock {
|
|
margin-top: 0;
|
|
}
|
|
table.tableblock {
|
|
border-width: 3px;
|
|
border-spacing: 0px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
border-collapse: collapse;
|
|
}
|
|
th.tableblock, td.tableblock {
|
|
border-width: 1px;
|
|
padding: 4px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
}
|
|
|
|
table.tableblock.frame-topbot {
|
|
border-left-style: hidden;
|
|
border-right-style: hidden;
|
|
}
|
|
table.tableblock.frame-sides {
|
|
border-top-style: hidden;
|
|
border-bottom-style: hidden;
|
|
}
|
|
table.tableblock.frame-none {
|
|
border-style: hidden;
|
|
}
|
|
|
|
th.tableblock.halign-left, td.tableblock.halign-left {
|
|
text-align: left;
|
|
}
|
|
th.tableblock.halign-center, td.tableblock.halign-center {
|
|
text-align: center;
|
|
}
|
|
th.tableblock.halign-right, td.tableblock.halign-right {
|
|
text-align: right;
|
|
}
|
|
|
|
th.tableblock.valign-top, td.tableblock.valign-top {
|
|
vertical-align: top;
|
|
}
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle {
|
|
vertical-align: middle;
|
|
}
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
|
vertical-align: bottom;
|
|
}
|
|
|
|
|
|
/*
|
|
* manpage specific
|
|
*
|
|
* */
|
|
|
|
body.manpage h1 {
|
|
padding-top: 0.5em;
|
|
padding-bottom: 0.5em;
|
|
border-top: 2px solid silver;
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
body.manpage h2 {
|
|
border-style: none;
|
|
}
|
|
body.manpage div.sectionbody {
|
|
margin-left: 3em;
|
|
}
|
|
|
|
@media print {
|
|
body.manpage div#toc { display: none; }
|
|
}
|
|
|
|
|
|
</style>
|
|
<script type="text/javascript">
|
|
/*<+'])');
|
|
// Function that scans the DOM tree for header elements (the DOM2
|
|
// nodeIterator API would be a better technique but not supported by all
|
|
// browsers).
|
|
var iterate = function (el) {
|
|
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
|
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
|
var mo = re.exec(i.tagName);
|
|
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
|
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
|
}
|
|
iterate(i);
|
|
}
|
|
}
|
|
}
|
|
iterate(el);
|
|
return result;
|
|
}
|
|
|
|
var toc = document.getElementById("toc");
|
|
if (!toc) {
|
|
return;
|
|
}
|
|
|
|
// Delete existing TOC entries in case we're reloading the TOC.
|
|
var tocEntriesToRemove = [];
|
|
var i;
|
|
for (i = 0; i < toc.childNodes.length; i++) {
|
|
var entry = toc.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div'
|
|
&& entry.getAttribute("class")
|
|
&& entry.getAttribute("class").match(/^toclevel/))
|
|
tocEntriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < tocEntriesToRemove.length; i++) {
|
|
toc.removeChild(tocEntriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild TOC entries.
|
|
var entries = tocEntries(document.getElementById("content"), toclevels);
|
|
for (var i = 0; i < entries.length; ++i) {
|
|
var entry = entries[i];
|
|
if (entry.element.id == "")
|
|
entry.element.id = "_toc_" + i;
|
|
var a = document.createElement("a");
|
|
a.href = "#" + entry.element.id;
|
|
a.appendChild(document.createTextNode(entry.text));
|
|
var div = document.createElement("div");
|
|
div.appendChild(a);
|
|
div.className = "toclevel" + entry.toclevel;
|
|
toc.appendChild(div);
|
|
}
|
|
if (entries.length == 0)
|
|
toc.parentNode.removeChild(toc);
|
|
},
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
// Footnotes generator
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
/* Based on footnote generation code from:
|
|
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
|
*/
|
|
|
|
footnotes: function () {
|
|
// Delete existing footnote entries in case we're reloading the footnodes.
|
|
var i;
|
|
var noteholder = document.getElementById("footnotes");
|
|
if (!noteholder) {
|
|
return;
|
|
}
|
|
var entriesToRemove = [];
|
|
for (i = 0; i < noteholder.childNodes.length; i++) {
|
|
var entry = noteholder.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
|
|
entriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < entriesToRemove.length; i++) {
|
|
noteholder.removeChild(entriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild footnote entries.
|
|
var cont = document.getElementById("content");
|
|
var spans = cont.getElementsByTagName("span");
|
|
var refs = {};
|
|
var n = 0;
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnote") {
|
|
n++;
|
|
var note = spans[i].getAttribute("data-note");
|
|
if (!note) {
|
|
// Use [\s\S] in place of . so multi-line matches work.
|
|
// Because JavaScript has no s (dotall) regex flag.
|
|
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
|
spans[i].innerHTML =
|
|
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
spans[i].setAttribute("data-note", note);
|
|
}
|
|
noteholder.innerHTML +=
|
|
"<div class='footnote' id='_footnote_" + n + "'>" +
|
|
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
|
n + "</a>. " + note + "</div>";
|
|
var id =spans[i].getAttribute("id");
|
|
if (id != null) refs["#"+id] = n;
|
|
}
|
|
}
|
|
if (n == 0)
|
|
noteholder.parentNode.removeChild(noteholder);
|
|
else {
|
|
// Process footnoterefs.
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnoteref") {
|
|
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
|
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
|
n = refs[href];
|
|
spans[i].innerHTML =
|
|
"[<a href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
install: function(toclevels) {
|
|
var timerId;
|
|
|
|
function reinstall() {
|
|
asciidoc.footnotes();
|
|
if (toclevels) {
|
|
asciidoc.toc(toclevels);
|
|
}
|
|
}
|
|
|
|
function reinstallAndRemoveTimer() {
|
|
clearInterval(timerId);
|
|
reinstall();
|
|
}
|
|
|
|
timerId = setInterval(reinstall, 500);
|
|
if (document.addEventListener)
|
|
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
|
else
|
|
window.onload = reinstallAndRemoveTimer;
|
|
}
|
|
|
|
}
|
|
asciidoc.install();
|
|
/*]]>*/
|
|
</script>
|
|
</head>
|
|
<body class="manpage">
|
|
<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>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_synopsis">SYNOPSIS</h2>
|
|
<div class="sectionbody">
|
|
<div class="verseblock">
|
|
<pre class="content"><code>git</code> <code>for-each-ref</code> [<code>--count=</code><em><count></em>] [<code>--shell</code>|<code>--perl</code>|<code>--python</code>|<code>--tcl</code>]
|
|
[(<code>--sort=</code><em><key></em>)<span>…]</span> [<code>--format=</code><em><format></em>]
|
|
[<code>--include-root-refs</code>] [<code>--points-at=</code><em><object></em>]
|
|
[<code>--merged</code>[<code>=</code><em><object></em>]] [<code>--no-merged</code>[<code>=</code><em><object></em>]]
|
|
[<code>--contains</code>[<code>=</code><em><object></em>]] [<code>--no-contains</code>[<code>=</code><em><object></em>]]
|
|
[(<code>--exclude=</code><em><pattern></em>)<span>…]</span> [<code>--start-after=</code><em><marker></em>]
|
|
[ <code>--stdin</code> | <em><pattern></em><code>…</code> ]</pre>
|
|
<div class="attribution">
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_description">DESCRIPTION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Iterate over all refs that match <em><pattern></em> and show them
|
|
according to the given <em><format></em>, after sorting them according
|
|
to the given set of <em><key></em>. If <em><count></em> is given, stop after
|
|
showing that many refs. The interpolated values in <em><format></em>
|
|
can optionally be quoted as string literals in the specified
|
|
host language allowing their direct evaluation in that language.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_options">OPTIONS</h2>
|
|
<div class="sectionbody">
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
<pattern>…
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
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.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--stdin
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
If <code>--stdin</code> is supplied, then the list of patterns is read from
|
|
standard input instead of from the argument list.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--count=<count>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
By default the command shows all refs that match
|
|
<em><pattern></em>. This option makes it stop after showing
|
|
that many refs.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--sort=<key>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
A field name to sort on. Prefix <code>-</code> to sort in
|
|
descending order of the value. When unspecified,
|
|
<code>refname</code> is used. You may use the --sort=<key> option
|
|
multiple times, in which case the last key becomes the primary
|
|
key.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--format=<format>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
A string that interpolates %(<code>fieldname</code>) from a ref being shown and
|
|
the object it points at. In addition, the string literal %%
|
|
renders as % and %xx - where <code>xx</code> are hex digits - renders as
|
|
the character with hex code <code>xx</code>. For example, %00 interpolates to
|
|
<code>\0</code> (NUL), %09 to <code>\t</code> (TAB), and %0a to <code>\n</code> (LF).
|
|
</p>
|
|
<div class="paragraph"><p>When unspecified, <em><format></em> defaults to %(<code>objectname</code>) <code>SPC</code> %(<code>objecttype</code>)
|
|
<code>TAB</code> %(<code>refname</code>).</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--color[=<when>]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Respect any colors specified in the <code>--format</code> option. The
|
|
<em><when></em> field must be one of <code>always</code>, <code>never</code>, or <code>auto</code> (if
|
|
<em><when></em> is absent, behave as if <code>always</code> was given).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--shell
|
|
</dt>
|
|
<dt class="hdlist1">
|
|
--perl
|
|
</dt>
|
|
<dt class="hdlist1">
|
|
--python
|
|
</dt>
|
|
<dt class="hdlist1">
|
|
--tcl
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
If given, strings that substitute %(<code>fieldname</code>)
|
|
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>
|
|
<dt class="hdlist1">
|
|
--points-at=<object>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only list refs which points at the given object.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--merged[=<object>]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only list refs whose tips are reachable from the
|
|
specified commit (HEAD if not specified).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--no-merged[=<object>]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only list refs whose tips are not reachable from the
|
|
specified commit (HEAD if not specified).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--contains[=<object>]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only list refs which contain the specified commit (HEAD if not
|
|
specified).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--no-contains[=<object>]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only list refs which don’t contain the specified commit (HEAD
|
|
if not specified).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--ignore-case
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Sorting and filtering refs are case insensitive.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--omit-empty
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Do not print a newline after formatted refs where the format expands
|
|
to the empty string.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--exclude=<pattern>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
If one or more patterns are given, only refs which do not match
|
|
any excluded pattern(s) are shown. Matching is done using the
|
|
same rules as <em><pattern></em> above.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--include-root-refs
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
List root refs (HEAD and pseudorefs) apart from regular refs.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--start-after=<marker>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Allows paginating the output by skipping references up to and including the
|
|
specified marker. When paging, it should be noted that references may be
|
|
deleted, modified or added between invocations. Output will only yield those
|
|
references which follow the marker lexicographically. Output begins from the
|
|
first reference that would come after the marker alphabetically. Cannot be
|
|
used with <code>--sort=</code><em><key></em> or <code>--stdin</code> options, or the <em><pattern></em> argument(s)
|
|
to limit the refs.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_field_names">FIELD NAMES</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Various values from structured fields in referenced objects can
|
|
be used to interpolate into the resulting output, or as sort
|
|
keys.</p></div>
|
|
<div class="paragraph"><p>For all objects, the following names can be used:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
refname
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The name of the ref (the part after $GIT_DIR/).
|
|
For a non-ambiguous short name of the ref append <code>:short</code>.
|
|
The option core.warnAmbiguousRefs is used to select the strict
|
|
abbreviation mode. If <code>lstrip=</code><em><N></em> (<code>rstrip=</code><em><N></em>) is appended, strips <em><N></em>
|
|
slash-separated path components from the front (back) of the refname
|
|
(e.g. %(<code>refname:lstrip=2</code>) turns <code>refs/tags/foo</code> into <code>foo</code> and
|
|
%(<code>refname:rstrip=2</code>) turns <code>refs/tags/foo</code> into <code>refs</code>).
|
|
If <em><N></em> is a negative number, strip as many path components as
|
|
necessary from the specified end to leave <code>-</code><em><N></em> path components
|
|
(e.g. %(<code>refname:lstrip=-2</code>) turns
|
|
<code>refs/tags/foo</code> into <code>tags/foo</code> and %(<code>refname:rstrip=-1</code>)
|
|
turns <code>refs/tags/foo</code> into <code>refs</code>). When the ref does not have
|
|
enough components, the result becomes an empty string if
|
|
stripping with positive <N>, or it becomes the full refname if
|
|
stripping with negative <N>. Neither is an error.
|
|
</p>
|
|
<div class="paragraph"><p><code>strip</code> can be used as a synonym to <code>lstrip</code>.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
objecttype
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The type of the object (<code>blob</code>, <code>tree</code>, <code>commit</code>, <code>tag</code>).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
objectsize
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The size of the object (the same as <em>git cat-file -s</em> reports).
|
|
Append <code>:disk</code> to get the size, in bytes, that the object takes up on
|
|
disk. See the note about on-disk sizes in the <code>CAVEATS</code> section below.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
objectname
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The object name (aka SHA-1).
|
|
For a non-ambiguous abbreviation of the object name append <code>:short</code>.
|
|
For an abbreviation of the object name with desired length append
|
|
<code>:short=</code><em><length></em>, where the minimum length is MINIMUM_ABBREV. The
|
|
length may be exceeded to ensure unique object names.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
deltabase
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This expands to the object name of the delta base for the
|
|
given object, if it is stored as a delta. Otherwise it
|
|
expands to the null object name (all zeroes).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
upstream
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The name of a local ref which can be considered “upstream”
|
|
from the displayed ref. Respects <code>:short</code>, <code>:lstrip</code> and
|
|
<code>:rstrip</code> in the same way as <code>refname</code> above. Additionally
|
|
respects <code>:track</code> to show "[ahead N, behind M]" and
|
|
<code>:trackshort</code> to show the terse version: ">" (ahead), "<"
|
|
(behind), "<>" (ahead and behind), or "=" (in sync). <code>:track</code>
|
|
also prints "[gone]" whenever unknown upstream ref is
|
|
encountered. Append <code>:track,nobracket</code> to show tracking
|
|
information without brackets (i.e "ahead N, behind M").
|
|
</p>
|
|
<div class="paragraph"><p>For any remote-tracking branch %(<code>upstream</code>), %(<code>upstream:remotename</code>)
|
|
and %(<code>upstream:remoteref</code>) refer to the name of the remote and the
|
|
name of the tracked remote ref, respectively. In other words, the
|
|
remote-tracking branch can be updated explicitly and individually by
|
|
using the refspec %(<code>upstream:remoteref</code>)<code>:</code>%(<code>upstream</code>) to fetch from
|
|
%(<code>upstream:remotename</code>).</p></div>
|
|
<div class="paragraph"><p>Has no effect if the ref does not have tracking information associated
|
|
with it. All the options apart from <code>nobracket</code> are mutually exclusive,
|
|
but if used together the last option is selected.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
push
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The name of a local ref which represents the <code>@</code>{push}
|
|
location for the displayed ref. Respects <code>:short</code>, <code>:lstrip</code>,
|
|
<code>:rstrip</code>, <code>:track</code>, <code>:trackshort</code>, <code>:remotename</code>, and <code>:remoteref</code>
|
|
options as <code>upstream</code> does. Produces an empty string if no <code>@</code>{push}
|
|
ref is configured.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
HEAD
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
<em>*</em> if HEAD matches current ref (the checked out branch), ' '
|
|
otherwise.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
color
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Change output color. Followed by <code>:</code><em><colorname></em>, where color
|
|
names are described under Values in the "CONFIGURATION FILE"
|
|
section of <a href="git-config.html">git-config(1)</a>. For example,
|
|
%(<code>color:bold</code> <code>red</code>).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
align
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Left-, middle-, or right-align the content between
|
|
%(align:…) and %(end). The "align:" is followed by
|
|
<code>width=</code><em><width></em> and <code>position=</code><em><position></em> in any order
|
|
separated by a comma, where the <em><position></em> is either left,
|
|
right or middle, default being left and <em><width></em> is the total
|
|
length of the content with alignment. For brevity, the
|
|
"width=" and/or "position=" prefixes may be omitted, and bare
|
|
<width> and <position> used instead. For instance,
|
|
%(<code>align:</code><em><width></em><code>,</code><em><position></em>). If the contents length is more
|
|
than the width then no alignment is performed. If used with
|
|
<code>--quote</code> everything in between %(align:…) and %(end) is
|
|
quoted, but if nested then only the topmost level performs
|
|
quoting.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
if
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Used as %(if)…%(then)…%(end) or
|
|
%(if)…%(then)…%(else)…%(end). If there is an atom with
|
|
value or string literal after the %(if) then everything after
|
|
the %(then) is printed, else if the %(else) atom is used, then
|
|
everything after %(else) is printed. We ignore space when
|
|
evaluating the string before %(then), this is useful when we
|
|
use the %(HEAD) atom which prints either "*" or " " and we
|
|
want to apply the <em>if</em> condition only on the <em>HEAD</em> ref.
|
|
Append ":equals=<string>" or ":notequals=<string>" to compare
|
|
the value between the %(if:…) and %(then) atoms with the
|
|
given string.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
symref
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The ref which the given symbolic ref refers to. If not a
|
|
symbolic ref, nothing is printed. Respects the <code>:short</code>,
|
|
<code>:lstrip</code> and <code>:rstrip</code> options in the same way as <code>refname</code>
|
|
above.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The GPG signature of a commit.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:grade
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Show "G" for a good (valid) signature, "B" for a bad
|
|
signature, "U" for a good signature with unknown validity, "X"
|
|
for a good signature that has expired, "Y" for a good
|
|
signature made by an expired key, "R" for a good signature
|
|
made by a revoked key, "E" if the signature cannot be
|
|
checked (e.g. missing key) and "N" for no signature.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:signer
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The signer of the GPG signature of a commit.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:key
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The key of the GPG signature of a commit.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:fingerprint
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The fingerprint of the GPG signature of a commit.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:primarykeyfingerprint
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The primary key fingerprint of the GPG signature of a commit.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
signature:trustlevel
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The trust level of the GPG signature of a commit. Possible
|
|
outputs are <code>ultimate</code>, <code>fully</code>, <code>marginal</code>, <code>never</code> and <code>undefined</code>.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
worktreepath
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The absolute path to the worktree in which the ref is checked
|
|
out, if it is checked out in any linked worktree. Empty string
|
|
otherwise.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
ahead-behind:<committish>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Two integers, separated by a space, demonstrating the number of
|
|
commits ahead and behind, respectively, when comparing the output
|
|
ref to the <em><committish></em> specified in the format.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
is-base:<committish>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
In at most one row, (<em><committish></em>) will appear to indicate the ref
|
|
that is most likely the ref used as a starting point for the branch
|
|
that produced <em><committish></em>. This choice is made using a heuristic:
|
|
choose the ref that minimizes the number of commits in the
|
|
first-parent history of <em><committish></em> and not in the first-parent
|
|
history of the ref.
|
|
</p>
|
|
<div class="paragraph"><p>For example, consider the following figure of first-parent histories of
|
|
several refs:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>*--*--*--*--*--* refs/heads/A
|
|
\
|
|
\
|
|
*--*--*--* refs/heads/B
|
|
\ \
|
|
\ \
|
|
* * refs/heads/C
|
|
\
|
|
\
|
|
*--* refs/heads/D</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Here, if <code>A</code>, <code>B</code>, and <code>C</code> are the filtered references, and the format
|
|
string is %(<code>refname</code>)<code>:</code>%(<code>is-base:D</code>), then the output would be</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>refs/heads/A:
|
|
refs/heads/B:(D)
|
|
refs/heads/C:</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>This is because the first-parent history of <code>D</code> has its earliest
|
|
intersection with the first-parent histories of the filtered refs at a
|
|
common first-parent ancestor of <code>B</code> and <code>C</code> and ties are broken by the
|
|
earliest ref in the sorted order.</p></div>
|
|
<div class="paragraph"><p>Note that this token will not appear if the first-parent history of
|
|
<em><committish></em> does not intersect the first-parent histories of the
|
|
filtered refs.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
describe[:options]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
A human-readable name, like <a href="git-describe.html">git-describe(1)</a>;
|
|
empty string for undescribable commits. The <code>describe</code> string may
|
|
be followed by a colon and one or more comma-separated options.
|
|
</p>
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
tags=<bool-value>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Instead of only considering annotated tags, consider
|
|
lightweight tags as well; see the corresponding option in
|
|
<a href="git-describe.html">git-describe(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
abbrev=<number>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Use at least <number> hexadecimal digits; see the corresponding
|
|
option in <a href="git-describe.html">git-describe(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
match=<pattern>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Only consider tags matching the given <code>glob</code>(<code>7</code>) pattern,
|
|
excluding the "refs/tags/" prefix; see the corresponding option
|
|
in <a href="git-describe.html">git-describe(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
exclude=<pattern>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Do not consider tags matching the given <code>glob</code>(<code>7</code>) pattern,
|
|
excluding the "refs/tags/" prefix; see the corresponding option
|
|
in <a href="git-describe.html">git-describe(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
</div></div>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>In addition to the above, for commit and tag objects, the header
|
|
field names (<code>tree</code>, <code>parent</code>, <code>object</code>, <code>type</code>, and <code>tag</code>) can
|
|
be used to specify the value in the header field.
|
|
Fields <code>tree</code> and <code>parent</code> can also be used with modifier <code>:short</code> and
|
|
<code>:short=</code><em><length></em> just like <code>objectname</code>.</p></div>
|
|
<div class="paragraph"><p>For commit and tag objects, the special <code>creatordate</code> and <code>creator</code>
|
|
fields will correspond to the appropriate date or name-email-date tuple
|
|
from the <code>committer</code> or <code>tagger</code> fields depending on the object type.
|
|
These are intended for working on a mix of annotated and lightweight tags.</p></div>
|
|
<div class="paragraph"><p>For tag objects, a <code>fieldname</code> prefixed with an asterisk (<code>*</code>) expands to
|
|
the <code>fieldname</code> value of the peeled object, rather than that of the tag
|
|
object itself.</p></div>
|
|
<div class="paragraph"><p>Fields that have name-email-date tuple as its value (<code>author</code>,
|
|
<code>committer</code>, and <code>tagger</code>) can be suffixed with <code>name</code>, <code>email</code>,
|
|
and <code>date</code> to extract the named component. For email fields (<code>authoremail</code>,
|
|
<code>committeremail</code> and <code>taggeremail</code>), <code>:trim</code> can be appended to get the email
|
|
without angle brackets, and <code>:localpart</code> to get the part before the <code>@</code> symbol
|
|
out of the trimmed email. In addition to these, the <code>:mailmap</code> option and the
|
|
corresponding <code>:mailmap,trim</code> and <code>:mailmap,localpart</code> can be used (order does
|
|
not matter) to get values of the name and email according to the .mailmap file
|
|
or according to the file set in the mailmap.file or mailmap.blob configuration
|
|
variable (see <a href="gitmailmap.html">gitmailmap(5)</a>).</p></div>
|
|
<div class="paragraph"><p>The raw data in an object is <code>raw</code>.</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
raw:size
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The raw data size of the object.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>Note that <code>--format=</code>%(<code>raw</code>) can not be used with <code>--python</code>, <code>--shell</code>, <code>--tcl</code>,
|
|
because such language may not support arbitrary binary data in their string
|
|
variable type.</p></div>
|
|
<div class="paragraph"><p>The message in a commit or a tag object is <code>contents</code>, from which
|
|
<code>contents:</code><em><part></em> can be used to extract various parts out of:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
contents:size
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The size in bytes of the commit or tag message.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
contents:subject
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The first paragraph of the message, which typically is a
|
|
single line, is taken as the "subject" of the commit or the
|
|
tag message.
|
|
Instead of <code>contents:subject</code>, field <code>subject</code> can also be used to
|
|
obtain same results. <code>:sanitize</code> can be appended to <code>subject</code> for
|
|
subject line suitable for filename.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
contents:body
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The remainder of the commit or the tag message that follows
|
|
the "subject".
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
contents:signature
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The optional GPG signature of the tag.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
contents:lines=N
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The first <code>N</code> lines of the message.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>Additionally, the trailers as interpreted by <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>
|
|
are obtained as <code>trailers</code>[<code>:options</code>] (or by using the historical alias
|
|
<code>contents:trailers</code>[<code>:options</code>]). For valid [:option] values see <code>trailers</code>
|
|
section of <a href="git-log.html">git-log(1)</a>.</p></div>
|
|
<div class="paragraph"><p>For sorting purposes, fields with numeric values sort in numeric order
|
|
(<code>objectsize</code>, <code>authordate</code>, <code>committerdate</code>, <code>creatordate</code>, <code>taggerdate</code>).
|
|
All other fields are used to sort in their byte-value order.</p></div>
|
|
<div class="paragraph"><p>There is also an option to sort by versions, this can be done by using
|
|
the fieldname <code>version:refname</code> or its alias <code>v:refname</code>.</p></div>
|
|
<div class="paragraph"><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>
|
|
<div class="paragraph"><p>As a special case for the date-type fields, you may specify a format for the
|
|
date by adding <code>:</code> followed by date format name (see the values the <code>--date</code>
|
|
option to <a href="git-rev-list.html">git-rev-list(1)</a> takes). If this formatting is provided in
|
|
a <code>--sort</code> key, references will be sorted according to the byte-value of the
|
|
formatted string rather than the numeric value of the underlying timestamp.</p></div>
|
|
<div class="paragraph"><p>Some atoms like %(align) and %(if) always require a matching %(end).
|
|
We call them "opening atoms" and sometimes denote them as %($open).</p></div>
|
|
<div class="paragraph"><p>When a scripting language specific quoting is in effect, everything
|
|
between a top-level opening atom and its matching %(end) is evaluated
|
|
according to the semantics of the opening atom and only its result
|
|
from the top-level is quoted.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_examples">EXAMPLES</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>An example directly producing formatted text. Show the most recent
|
|
3 tagged commits:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>#!/bin/sh
|
|
|
|
git for-each-ref --count=3 --sort='-*authordate' \
|
|
--format='From: %(*authorname) %(*authoremail)
|
|
Subject: %(*subject)
|
|
Date: %(*authordate)
|
|
Ref: %(*refname)
|
|
|
|
%(*body)
|
|
' 'refs/tags'</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><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>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>#!/bin/sh
|
|
|
|
git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
|
|
while read entry
|
|
do
|
|
eval "$entry"
|
|
echo `dirname $ref`
|
|
done</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>A bit more elaborate report on tags, demonstrating that the format
|
|
may be an entire script:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>#!/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"</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>An example to show the usage of %(if)…%(then)…%(else)…%(end).
|
|
This prefixes the current branch with a star.</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>An example to show the usage of %(if)…%(then)…%(end).
|
|
This prints the authorname, if present.</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_caveats">CAVEATS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Note that the sizes of objects on disk are reported accurately, but care
|
|
should be taken in drawing conclusions about which refs or objects are
|
|
responsible for disk usage. The size of a packed non-delta object may be
|
|
much larger than the size of objects which delta against it, but the
|
|
choice of which object is the base and which is the delta is arbitrary
|
|
and is subject to change during a repack.</p></div>
|
|
<div class="paragraph"><p>Note also that multiple copies of an object may be present in the object
|
|
database; in this case, it is undefined which copy’s size or delta base
|
|
will be reported.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_notes">NOTES</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>When combining multiple <code>--contains</code> and <code>--no-contains</code> filters, only
|
|
references that contain at least one of the <code>--contains</code> commits and
|
|
contain none of the <code>--no-contains</code> commits are shown.</p></div>
|
|
<div class="paragraph"><p>When combining multiple <code>--merged</code> and <code>--no-merged</code> filters, only
|
|
references that are reachable from at least one of the <code>--merged</code>
|
|
commits and from none of the <code>--no-merged</code> commits are shown.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_see_also">SEE ALSO</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p><a href="git-show-ref.html">git-show-ref(1)</a></p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_git">GIT</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated
|
|
2025-08-18 02:18:23 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|