diff options
author | Junio C Hamano <gitster@pobox.com> | 2023-07-06 12:49:58 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2023-07-06 12:49:58 -0700 |
commit | 85a512276c1db22d8401ea9fafef04474894b024 (patch) | |
tree | 8eb4a0998e6dfc38c5ab8a7f97a436952da914fe /git-notes.html | |
parent | 0f401e173c76a32b3c9ef8426f1e57ca7136e188 (diff) | |
download | git-htmldocs-85a512276c1db22d8401ea9fafef04474894b024.tar.gz |
Autogenerated HTML docs for v2.41.0-318-g061c586
Diffstat (limited to 'git-notes.html')
-rw-r--r-- | git-notes.html | 55 |
1 files changed, 45 insertions, 10 deletions
diff --git a/git-notes.html b/git-notes.html index 230ed94ac..6de6c1d81 100644 --- a/git-notes.html +++ b/git-notes.html @@ -750,10 +750,10 @@ git-notes(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>git notes</em> [list [<object>]]
-<em>git notes</em> add [-f] [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+<em>git notes</em> add [-f] [--allow-empty] [--[no-]separator | --separator=<paragraph-break>] [--[no-]stripspace] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
<em>git notes</em> copy [-f] ( --stdin | <from-object> [<to-object>] )
-<em>git notes</em> append [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
-<em>git notes</em> edit [--allow-empty] [<object>]
+<em>git notes</em> append [--allow-empty] [--[no-]separator | --separator=<paragraph-break>] [--[no-]stripspace] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+<em>git notes</em> edit [--allow-empty] [<object>] [--[no-]stripspace]
<em>git notes</em> show [<object>]
<em>git notes</em> merge [-v | -q] [-s <strategy> ] <notes-ref>
<em>git notes</em> merge --commit [-v | -q]
@@ -814,7 +814,9 @@ add However, if you’re using <code>add</code> 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>
- subcommand).
+ subcommand). If you specify multiple <code>-m</code> and <code>-F</code>, a blank
+ line will be inserted between the messages. Use the <code>--separator</code>
+ option to insert other delimiters.
</p>
</dd>
<dt class="hdlist1">
@@ -842,8 +844,12 @@ append </dt>
<dd>
<p>
- Append to the notes of an existing object (defaults to HEAD).
- Creates a new notes object if needed.
+ Append new message(s) given by <code>-m</code> or <code>-F</code> options to an
+ existing note, or add them as a new note if one does not
+ exist, for the object (defaults to HEAD). When appending to
+ an existing note, a blank line is added before each new
+ message as an inter-paragraph separator. The separator can
+ be customized with the <code>--separator</code> option.
</p>
</dd>
<dt class="hdlist1">
@@ -940,7 +946,8 @@ get-ref If multiple <code>-m</code> options are given, their values
are concatenated as separate paragraphs.
Lines starting with <code>#</code> and empty lines other than a
- single line between paragraphs will be stripped out.
+ single line between paragraphs will be stripped out,
+ if you wish to keep them verbatim, use <code>--no-stripspace</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -954,7 +961,9 @@ get-ref 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
- single line between paragraphs will be stripped out.
+ single line between paragraphs will be stripped out,
+ if you wish to keep them verbatim, use with
+ <code>--no-stripspace</code> option.
</p>
</dd>
<dt class="hdlist1">
@@ -967,7 +976,10 @@ get-ref <p>
Take the given blob object (for example, another note) as the
note message. (Use <code>git notes copy <object></code> instead to
- copy notes between objects.)
+ copy notes between objects.). By default, message will be
+ copied verbatim, but if you wish to strip out the lines
+ starting with <code>#</code> and empty lines other than a single line
+ between paragraphs, use with`--stripspace` option.
</p>
</dd>
<dt class="hdlist1">
@@ -992,6 +1004,29 @@ get-ref </p>
</dd>
<dt class="hdlist1">
+--[no-]separator, --separator=<paragraph-break>
+</dt>
+<dd>
+<p>
+ Specify a string used as a custom inter-paragraph separator
+ (a newline is added at the end as needed). If <code>--no-separator</code>, no
+ separators will be added between paragraphs. Defaults to a blank
+ line.
+</p>
+</dd>
+<dt class="hdlist1">
+--[no-]stripspace
+</dt>
+<dd>
+<p>
+ Strip leading and trailing whitespace from the note message.
+ Also strip out empty lines other than a single line between
+ paragraphs. For lines starting with <code>#</code> will be stripped out
+ in non-editor cases like "-m", "-F" and "-C", but not in
+ editor case like "git notes edit", "-c", etc.
+</p>
+</dd>
+<dt class="hdlist1">
--ref <ref>
</dt>
<dd>
@@ -1362,7 +1397,7 @@ on the <code>notes.rewrite.<command></code> and <code>notes.rewriteRef</co <div id="footer">
<div id="footer-text">
Last updated
- 2022-09-14 13:23:11 PDT
+ 2023-07-06 12:47:39 PDT
</div>
</div>
</body>
|