From: Sebastian Schuberth <sschuberth@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH] doc: Clarify which objects notes can be attached to
Date: Mon, 4 Apr 2016 10:37:46 +0200 [thread overview]
Message-ID: <570227DA.6040808@gmail.com> (raw)
In-Reply-To: <CAHGBnuP71qpOoNAAwXE-nbPbVyK56Up0YpmhhjC5430VwW73kQ@mail.gmail.com>
Explicitly name the supported object types, and ensure patches cannot be
misinterpreted as non-objects that can have notes attached.
Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
---
Documentation/git-notes.txt | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 8de3499..101e6ba 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -25,7 +25,8 @@ SYNOPSIS
DESCRIPTION
-----------
Adds, removes, or reads notes attached to objects, without touching
-the objects themselves.
+the objects themselves. Supported objects are commits, blobs, trees
+and annotated tags.
By default, notes are saved to and read from `refs/notes/commits`, but
this default can be overridden. See the OPTIONS, CONFIGURATION, and
@@ -39,9 +40,9 @@ message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<refname>):" (or
"Notes:" for `refs/notes/commits`).
-Notes can also be added to patches prepared with `git format-patch` by
-using the `--notes` option. Such notes are added as a patch commentary
-after a three dash separator line.
+Notes contents can also be included in patches prepared with
+`git format-patch` by using the `--notes` option. Such notes are added
+as a patch commentary after a three dash separator line.
To change which notes are shown by 'git log', see the
"notes.displayRef" configuration in linkgit:git-log[1].
--
2.8.0.windows.1
next prev parent reply other threads:[~2016-04-04 8:37 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-01 10:09 [PATCH] doc: clarify that notes can be attached to any type of stored object Sebastian Schuberth
2016-04-01 15:31 ` Junio C Hamano
2016-04-01 16:47 ` Junio C Hamano
2016-04-04 8:33 ` Sebastian Schuberth
2016-04-04 8:37 ` Sebastian Schuberth [this message]
2016-04-04 16:39 ` Junio C Hamano
2016-04-04 8:10 ` Sebastian Schuberth
2016-04-04 18:04 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=570227DA.6040808@gmail.com \
--to=sschuberth@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.