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

Re: [PATCH 4/4] Documentation/notes: nitpicks

From
Thomas Rast <trast@student.ethz.ch>
Date
May 4, 2010, 07:09 UTC
Message-ID
<201005040909.43247.trast@student.ethz.ch>
In-Reply-To
<20100503234720.GD27483@progeny.tock>
Jonathan Nieder wrote:
Show 10 quoted lines
> -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
> +A typical use of notes is to supplement a commit message without
> +changing the commit itself. Notes can be shown by 'git log' 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 the default setting).
> +"Notes:" for the main notes ref).

Nitpick on your nitpick: we do not call refs/notes/commits the "main" notes ref anywhere, and you don't seem to introduce this terminology.

The user might infer that "main" means core.notesRef, but the omission of (<refname>) is actually hardcoded to only happen for refs/notes/commits, so that's not correct.

[I'll review the other patches after the lecture.]
-- 
Thomas Rast
trast@{inf,student}.ethz.ch
Previous: Jonathan NiederNext: Jonathan Nieder
Message 10 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.