git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/4] Documentation/notes: adjust description to use configuration section

From
Jonathan Nieder <jrnieder@gmail.com>
Date
May 3, 2010, 23:42 UTC
Message-ID
<20100503234209.GB27483@progeny.tock>
In-Reply-To
<20100503233604.GA27451@progeny.tock>

Introduce the default notes ref early on to give the reader a frame of reference for understanding the rest of the description.

Cc: Johan Herland <johan@herland.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-notes.txt |   14 ++++++--------
 1 files changed, 6 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index b26598e..0594776 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -23,6 +23,10 @@ DESCRIPTION
 This command allows you to add/remove notes to/from objects, without
 changing the objects themselves.
 
+By default, notes are saved to and read from `refs/notes/commits`, but
+this default can be overridden.  See the CONFIGURATION and ENVIRONMENT
+sections below.
+
 A typical use of notes is to extend a commit message without having
 to change the commit itself. Such commit notes can be shown by `git log`
 along with the original commit message. To discern these notes from the
@@ -30,14 +34,8 @@ message stored in the commit object, the notes are indented like the
 message, after an unindented line saying "Notes (<refname>):" (or
 "Notes:" for the default setting).
 
-This command always manipulates the notes specified in "core.notesRef"
-(see linkgit:git-config[1]), which can be overridden by GIT_NOTES_REF.
-To change which notes are shown by 'git-log', see the
-"notes.displayRef" configuration.
-
-See the description of "notes.rewrite.<command>" in
-linkgit:git-config[1] for a way of carrying your notes across commands
-that rewrite commits.
+See the "notes.rewrite.<command>" configuration for a way of carrying
+notes across commands that rewrite commits.
 
 
 SUBCOMMANDS
-- 
1.7.1
Previous: Thomas RastNext: Jonathan Nieder
Message 4 of 11 in “Documentation/notes: fill out the man page a little”
  1. 0/4 Documentation/notes: fill out the man page a littleJonathan Nieder, May 3, 2010
  2. 1/4 Documentation/notes: describe effect of environment and configurationJonathan Nieder, May 3, 2010
  3. Thomas RastMay 4, 2010
  4. 2/4 Documentation/notes: adjust description to use configuration sectionJonathan Nieder, May 3, 2010
  5. 3/4 Documentation/notes: describe content of notesJonathan Nieder, May 3, 2010
  6. Thomas RastMay 4, 2010
  7. Johan HerlandMay 4, 2010
  8. Jeff KingMay 5, 2010
  9. 4/4 Documentation/notes: nitpicksJonathan Nieder, May 3, 2010
  10. Thomas RastMay 4, 2010
  11. Jonathan NiederMay 4, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.