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

[PATCH] notes: fix erroneous "git notes prune [-n | -v]" message

From
Robert P. J. Day <rpjday@crashcourse.ca>
Date
Nov 21, 2017, 17:00 UTC
Message-ID
<alpine.LFD.2.21.1711211156110.10397@DESKTOP-1GPMCEJ>

It seems clear that the man page SYNPOSIS and the usage message referring to:

  git notes prune [-n | -v]

is incorrect, as "-n" (dry run) and "-v" (verbose) are not alternatives, so fix both places to refer to:

  git notes prune [-n] [-v | -q]
to match the rest of the man page.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
---
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 43677297f..c75748963 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -18,7 +18,7 @@ SYNOPSIS
 'git notes' merge --commit [-v | -q]
 'git notes' merge --abort [-v | -q]
 'git notes' remove [--ignore-missing] [--stdin] [<object>...]
-'git notes' prune [-n | -v]
+'git notes' prune [-n] [-v | -q]
 'git notes' get-ref


diff --git a/builtin/notes.c b/builtin/notes.c
index d7754db14..43bfe3d6a 100644
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -33,7 +33,7 @@ static const char * const git_notes_usage[] = {
 	N_("git notes merge --commit [-v | -q]"),
 	N_("git notes merge --abort [-v | -q]"),
 	N_("git notes [--ref <notes-ref>] remove [<object>...]"),
-	N_("git notes [--ref <notes-ref>] prune [-n | -v]"),
+	N_("git notes [--ref <notes-ref>] prune [-n] [-v | -q]"),
 	N_("git notes [--ref <notes-ref>] get-ref"),
 	NULL
 };
-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
Next: Jonathan Nieder
Message 1 of 4 in “notes: fix erroneous "git notes prune [-n | -v]" message”
  1. notes: fix erroneous "git notes prune [-n | -v]" messageRobert P. J. Day, Nov 21, 2017
  2. Jonathan NiederNov 21, 2017
  3. Robert P. J. DayNov 21, 2017
  4. Jonathan NiederNov 21, 2017

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.