diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-01-17 14:46:49 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-01-17 14:46:49 -0800 |
| commit | 61525f915b47e953b4288a9afcee45e47b352214 (patch) | |
| tree | f0649f89cc7a77c0296305f4673fc2bc7e0a6d54 /git-notes.html | |
| parent | bc8d4783cac3c942fc9e8cf2f3eae4aea8cab5cb (diff) | |
| download | git-htmldocs-61525f915b47e953b4288a9afcee45e47b352214.tar.gz | |
Autogenerated HTML docs for v1.9-rc0
Diffstat (limited to 'git-notes.html')
| -rw-r--r-- | git-notes.html | 118 |
1 files changed, 61 insertions, 57 deletions
diff --git a/git-notes.html b/git-notes.html index e432c6ce3..f6509c0ae 100644 --- a/git-notes.html +++ b/git-notes.html @@ -3,7 +3,7 @@ <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 8.6.8" />
+<meta name="generator" content="AsciiDoc 8.6.6" />
<title>git-notes(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -87,15 +87,11 @@ ul, ol, li > p { ul > li { color: #aaa; }
ul > li > * { color: black; }
-.monospaced, code, pre {
- font-family: "Courier New", Courier, monospace;
- font-size: inherit;
- color: navy;
+pre {
padding: 0;
margin: 0;
}
-
#author {
color: #527bbd;
font-weight: bold;
@@ -353,7 +349,7 @@ div.colist td img { margin-bottom: 0.1em;
}
-div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -411,14 +407,18 @@ 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
*
* */
+tt {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -452,6 +452,12 @@ div.tableblock > table[frame="vsides"] { *
* */
+.monospaced {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -531,8 +537,6 @@ body.manpage div.sectionbody { @media print {
body.manpage div#toc { display: none; }
}
-
-
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -606,7 +610,7 @@ toc: function (toclevels) { var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div'
+ if (entry.nodeName == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
@@ -652,7 +656,7 @@ footnotes: function () { var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
@@ -767,7 +771,7 @@ git-notes(1) Manual Page <div class="sectionbody">
<div class="paragraph"><p>Adds, removes, or reads notes attached to objects, without touching
the objects themselves.</p></div>
-<div class="paragraph"><p>By default, notes are saved to and read from <code>refs/notes/commits</code>, but
+<div class="paragraph"><p>By default, notes are saved to and read from <tt>refs/notes/commits</tt>, but
this default can be overridden. See the OPTIONS, CONFIGURATION, and
ENVIRONMENT sections below. If this ref does not exist, it will be
quietly created when it is first needed to store a note.</p></div>
@@ -776,9 +780,9 @@ changing the commit itself. Notes can be shown by <em>git log</em> along with the original commit message. To distinguish these notes from the
message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<refname>):" (or
-"Notes:" for <code>refs/notes/commits</code>).</p></div>
-<div class="paragraph"><p>Notes can also be added to patches prepared with <code>git format-patch</code> by
-using the <code>--notes</code> option. Such notes are added as a patch commentary
+"Notes:" for <tt>refs/notes/commits</tt>).</p></div>
+<div class="paragraph"><p>Notes can also be added to patches prepared with <tt>git format-patch</tt> by
+using the <tt>--notes</tt> option. Such notes are added as a patch commentary
after a three dash separator line.</p></div>
<div class="paragraph"><p>To change which notes are shown by <em>git log</em>, see the
"notes.displayRef" configuration in <a href="git-log.html">git-log(1)</a>.</p></div>
@@ -807,10 +811,10 @@ add <dd>
<p>
Add notes for a given object (defaults to HEAD). Abort if the
- object already has notes (use <code>-f</code> to overwrite existing notes).
- However, if you’re using <code>add</code> interactively (using an editor
+ object already has notes (use <tt>-f</tt> to overwrite existing notes).
+ However, if you’re using <tt>add</tt> interactively (using an editor
to supply the notes contents), then - instead of aborting -
- the existing notes will be opened in the editor (like the <code>edit</code>
+ the existing notes will be opened in the editor (like the <tt>edit</tt>
subcommand).
</p>
</dd>
@@ -823,16 +827,16 @@ copy Abort if the second object already has notes, or if the first
object has none (use -f to overwrite existing notes to the
second object). This subcommand is equivalent to:
- <code>git notes add [-f] -C $(git notes list <from-object>) <to-object></code>
+ <tt>git notes add [-f] -C $(git notes list <from-object>) <to-object></tt>
</p>
-<div class="paragraph"><p>In <code>--stdin</code> mode, take lines in the format</p></div>
+<div class="paragraph"><p>In <tt>--stdin</tt> mode, take lines in the format</p></div>
<div class="listingblock">
<div class="content">
-<pre><code><from-object> SP <to-object> [ SP <rest> ] LF</code></pre>
+<pre><tt><from-object> SP <to-object> [ SP <rest> ] LF</tt></pre>
</div></div>
<div class="paragraph"><p>on standard input, and copy the notes from each <from-object> to its
-corresponding <to-object>. (The optional <code><rest></code> is ignored so that
-the command can read the input given to the <code>post-rewrite</code> hook.)</p></div>
+corresponding <to-object>. (The optional <tt><rest></tt> is ignored so that
+the command can read the input given to the <tt>post-rewrite</tt> hook.)</p></div>
</dd>
<dt class="hdlist1">
append
@@ -872,7 +876,7 @@ merge <div class="paragraph"><p>If conflicts arise and a strategy for automatically resolving
conflicting notes (see the -s/--strategy option) is not given,
the "manual" resolver is used. This resolver checks out the
-conflicting notes in a special worktree (<code>.git/NOTES_MERGE_WORKTREE</code>),
+conflicting notes in a special worktree (<tt>.git/NOTES_MERGE_WORKTREE</tt>),
and instructs the user to manually resolve the conflicts there.
When done, the user can either finalize the merge with
<em>git notes merge --commit</em>, or abort the merge with
@@ -886,7 +890,7 @@ remove Remove the notes for given objects (defaults to HEAD). When
giving zero or one object from the command line, this is
equivalent to specifying an empty note message to
- the <code>edit</code> subcommand.
+ the <tt>edit</tt> subcommand.
</p>
</dd>
<dt class="hdlist1">
@@ -934,9 +938,9 @@ get-ref <dd>
<p>
Use the given note message (instead of prompting).
- If multiple <code>-m</code> options are given, their values
+ If multiple <tt>-m</tt> options are given, their values
are concatenated as separate paragraphs.
- Lines starting with <code>#</code> and empty lines other than a
+ Lines starting with <tt>#</tt> and empty lines other than a
single line between paragraphs will be stripped out.
</p>
</dd>
@@ -950,7 +954,7 @@ get-ref <p>
Take the note message from the given file. Use <em>-</em> to
read the note message from the standard input.
- Lines starting with <code>#</code> and empty lines other than a
+ Lines starting with <tt>#</tt> and empty lines other than a
single line between paragraphs will be stripped out.
</p>
</dd>
@@ -963,7 +967,7 @@ get-ref <dd>
<p>
Take the given blob object (for example, another note) as the
- note message. (Use <code>git notes copy <object></code> instead to
+ note message. (Use <tt>git notes copy <object></tt> instead to
copy notes between objects.)
</p>
</dd>
@@ -986,7 +990,7 @@ get-ref <p>
Manipulate the notes tree in <ref>. This overrides
<em>GIT_NOTES_REF</em> and the "core.notesRef" configuration. The ref
- is taken to be in <code>refs/notes/</code> if it is not qualified.
+ is taken to be in <tt>refs/notes/</tt> if it is not qualified.
</p>
</dd>
<dt class="hdlist1">
@@ -1095,18 +1099,18 @@ are taken from notes refs. A notes ref is usually a branch which contains "files" whose paths are the object names for the objects
they describe, with some directory separators included for performance
reasons <span class="footnote"><br />[Permitted pathnames have the form
-<em>ab</em><code>/</code><em>cd</em><code>/</code><em>ef</em><code>/</code><em>…</em><code>/</code><em>abcdef…</em>: a sequence of directory
+<em>ab</em><tt>/</tt><em>cd</em><tt>/</tt><em>ef</em><tt>/</tt><em>…</em><tt>/</tt><em>abcdef…</em>: a sequence of directory
names of two hexadecimal digits each followed by a filename with the
rest of the object ID.]<br /></span>.</p></div>
<div class="paragraph"><p>Every notes change creates a new commit at the specified notes ref.
You can therefore inspect the history of the notes by invoking, e.g.,
-<code>git log -p notes/commits</code>. Currently the commit message only records
+<tt>git log -p notes/commits</tt>. Currently the commit message only records
which operation triggered the update, and the commit authorship is
determined according to the usual rules (see <a href="git-commit.html">git-commit(1)</a>).
These details may change in the future.</p></div>
<div class="paragraph"><p>It is also permitted for a notes ref to point directly to a tree
object, in which case the history of the notes can be read with
-<code>git log -p -g <refname></code>.</p></div>
+<tt>git log -p -g <refname></tt>.</p></div>
</div>
</div>
<div class="sect1">
@@ -1114,7 +1118,7 @@ object, in which case the history of the notes can be read with <div class="sectionbody">
<div class="paragraph"><p>The default notes merge strategy is "manual", which checks out
conflicting notes in a special work tree for resolving notes conflicts
-(<code>.git/NOTES_MERGE_WORKTREE</code>), and instructs the user to resolve the
+(<tt>.git/NOTES_MERGE_WORKTREE</tt>), and instructs the user to resolve the
conflicts in that work tree.
When done, the user can either finalize the merge with
<em>git notes merge --commit</em>, or abort the merge with
@@ -1144,24 +1148,24 @@ strategy.</p></div> available at the time a commit was written.</p></div>
<div class="listingblock">
<div class="content">
-<pre><code>$ git notes add -m 'Tested-by: Johannes Sixt <j6t@kdbg.org>' 72a144e2
+<pre><tt>$ git notes add -m 'Tested-by: Johannes Sixt <j6t@kdbg.org>' 72a144e2
$ git show -s 72a144e
[...]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Notes:
- Tested-by: Johannes Sixt <j6t@kdbg.org></code></pre>
+ Tested-by: Johannes Sixt <j6t@kdbg.org></tt></pre>
</div></div>
<div class="paragraph"><p>In principle, a note is a regular Git blob, and any kind of
(non-)format is accepted. You can binary-safely create notes from
arbitrary files using <em>git hash-object</em>:</p></div>
<div class="listingblock">
<div class="content">
-<pre><code>$ cc *.c
+<pre><tt>$ cc *.c
$ blob=$(git hash-object -w a.out)
-$ git notes --ref=built add -C "$blob" HEAD</code></pre>
+$ git notes --ref=built add -C "$blob" HEAD</tt></pre>
</div></div>
-<div class="paragraph"><p>(You cannot simply use <code>git notes --ref=built add -F a.out HEAD</code>
+<div class="paragraph"><p>(You cannot simply use <tt>git notes --ref=built add -F a.out HEAD</tt>
because that is not binary-safe.)
Of course, it doesn’t make much sense to display non-text-format notes
with <em>git log</em>, so if you use such notes, you’ll probably need to write
@@ -1178,7 +1182,7 @@ core.notesRef <dd>
<p>
Notes ref to read and manipulate instead of
- <code>refs/notes/commits</code>. Must be an unabbreviated ref name.
+ <tt>refs/notes/commits</tt>. Must be an unabbreviated ref name.
This setting can be overridden through the environment and
command line.
</p>
@@ -1189,7 +1193,7 @@ notes.displayRef <dd>
<p>
Which ref (or refs, if a glob or specified more than once), in
- addition to the default set by <code>core.notesRef</code> or
+ addition to the default set by <tt>core.notesRef</tt> or
<em>GIT_NOTES_REF</em>, to read notes from when showing commit
messages with the <em>git log</em> family of commands.
This setting can be overridden on the command line or by the
@@ -1202,10 +1206,10 @@ notes.rewrite.<command> </dt>
<dd>
<p>
- When rewriting commits with <command> (currently <code>amend</code> or
- <code>rebase</code>), if this variable is <code>false</code>, git will not copy
+ When rewriting commits with <command> (currently <tt>amend</tt> or
+ <tt>rebase</tt>), if this variable is <tt>false</tt>, git will not copy
notes from the original to the rewritten commit. Defaults to
- <code>true</code>. See also "<code>notes.rewriteRef</code>" below.
+ <tt>true</tt>. See also "<tt>notes.rewriteRef</tt>" below.
</p>
<div class="paragraph"><p>This setting can be overridden by the <em>GIT_NOTES_REWRITE_REF</em>
environment variable.</p></div>
@@ -1216,10 +1220,10 @@ notes.rewriteMode <dd>
<p>
When copying notes during a rewrite, what to do if the target
- commit already has a note. Must be one of <code>overwrite</code>,
- <code>concatenate</code>, and <code>ignore</code>. Defaults to <code>concatenate</code>.
+ commit already has a note. Must be one of <tt>overwrite</tt>,
+ <tt>concatenate</tt>, and <tt>ignore</tt>. Defaults to <tt>concatenate</tt>.
</p>
-<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
+<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
environment variable.</p></div>
</dd>
<dt class="hdlist1">
@@ -1248,8 +1252,8 @@ enable note rewriting.</p></div> </dt>
<dd>
<p>
- Which ref to manipulate notes from, instead of <code>refs/notes/commits</code>.
- This overrides the <code>core.notesRef</code> setting.
+ Which ref to manipulate notes from, instead of <tt>refs/notes/commits</tt>.
+ This overrides the <tt>core.notesRef</tt> setting.
</p>
</dd>
<dt class="hdlist1">
@@ -1258,10 +1262,10 @@ enable note rewriting.</p></div> <dd>
<p>
Colon-delimited list of refs or globs indicating which refs,
- in addition to the default from <code>core.notesRef</code> or
+ in addition to the default from <tt>core.notesRef</tt> or
<em>GIT_NOTES_REF</em>, to read notes from when showing commit
messages.
- This overrides the <code>notes.displayRef</code> setting.
+ This overrides the <tt>notes.displayRef</tt> setting.
</p>
<div class="paragraph"><p>A warning will be issued for refs that do not exist, but a glob that
does not match any refs is silently ignored.</p></div>
@@ -1273,8 +1277,8 @@ does not match any refs is silently ignored.</p></div> <p>
When copying notes during a rewrite, what to do if the target
commit already has a note.
- Must be one of <code>overwrite</code>, <code>concatenate</code>, and <code>ignore</code>.
- This overrides the <code>core.rewriteMode</code> setting.
+ Must be one of <tt>overwrite</tt>, <tt>concatenate</tt>, and <tt>ignore</tt>.
+ This overrides the <tt>core.rewriteMode</tt> setting.
</p>
</dd>
<dt class="hdlist1">
@@ -1287,7 +1291,7 @@ does not match any refs is silently ignored.</p></div> refs or globs.
</p>
<div class="paragraph"><p>If not set in the environment, the list of notes to copy depends
-on the <code>notes.rewrite.<command></code> and <code>notes.rewriteRef</code> settings.</p></div>
+on the <tt>notes.rewrite.<command></tt> and <tt>notes.rewriteRef</tt> settings.</p></div>
</dd>
</dl></div>
</div>
|