{"thread":{"id":"47275","subject":"[PATCH] notes: fix erroneous \"git notes prune [-n | -v]\" message","startedAt":"2017-11-21T17:01:55Z","lastAt":"2017-11-21T18:38:57Z","messageCount":4,"participants":["Robert P. J. Day","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"333107","messageId":"alpine.LFD.2.21.1711211156110.10397@DESKTOP-1GPMCEJ","threadId":"47275","inReplyTo":null,"subject":"[PATCH] notes: fix erroneous \"git notes prune [-n | -v]\" message","fromName":"Robert P. J. Day","fromEmail":"rpjday@crashcourse.ca","sentAt":"2017-11-21T17:00:29Z","receivedAt":"2017-11-21T17:01:55Z","isPatch":true,"sender":{"key":"rpjday@crashcourse.ca","avatar":"https://avatars.githubusercontent.com/u/226084077?v=4"},"body":"It seems clear that the man page SYNPOSIS and the usage message\nreferring to:\n\n  git notes prune [-n | -v]\n\nis incorrect, as \"-n\" (dry run) and \"-v\" (verbose) are not\nalternatives, so fix both places to refer to:\n\n  git notes prune [-n] [-v | -q]\n\nto match the rest of the man page.\n\nSigned-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n\n---\n\ndiff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt\nindex 43677297f..c75748963 100644\n--- a/Documentation/git-notes.txt\n+++ b/Documentation/git-notes.txt\n@@ -18,7 +18,7 @@ SYNOPSIS\n 'git notes' merge --commit [-v | -q]\n 'git notes' merge --abort [-v | -q]\n 'git notes' remove [--ignore-missing] [--stdin] [<object>...]\n-'git notes' prune [-n | -v]\n+'git notes' prune [-n] [-v | -q]\n 'git notes' get-ref\n\n\ndiff --git a/builtin/notes.c b/builtin/notes.c\nindex d7754db14..43bfe3d6a 100644\n--- a/builtin/notes.c\n+++ b/builtin/notes.c\n@@ -33,7 +33,7 @@ static const char * const git_notes_usage[] = {\n \tN_(\"git notes merge --commit [-v | -q]\"),\n \tN_(\"git notes merge --abort [-v | -q]\"),\n \tN_(\"git notes [--ref <notes-ref>] remove [<object>...]\"),\n-\tN_(\"git notes [--ref <notes-ref>] prune [-n | -v]\"),\n+\tN_(\"git notes [--ref <notes-ref>] prune [-n] [-v | -q]\"),\n \tN_(\"git notes [--ref <notes-ref>] get-ref\"),\n \tNULL\n };\n\n-- \n\n========================================================================\nRobert P. J. Day                                 Ottawa, Ontario, CANADA\n                        http://crashcourse.ca\n\nTwitter:                                       http://twitter.com/rpjday\nLinkedIn:                               http://ca.linkedin.com/in/rpjday\n========================================================================\n"},{"id":"333111","messageId":"20171121175846.GB27041@aiede.mtv.corp.google.com","threadId":"47275","inReplyTo":"alpine.LFD.2.21.1711211156110.10397@DESKTOP-1GPMCEJ","subject":"Re: [PATCH] notes: fix erroneous \"git notes prune [-n | -v]\" message","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-11-21T17:58:46Z","receivedAt":"2017-11-21T17:58:53Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi,\n\nRobert P. J. Day wrote:\n\n> It seems clear that the man page SYNPOSIS and the usage message\n> referring to:\n>\n>   git notes prune [-n | -v]\n>\n> is incorrect, as \"-n\" (dry run) and \"-v\" (verbose) are not\n> alternatives, so fix both places to refer to:\n>\n>   git notes prune [-n] [-v | -q]\n>\n> to match the rest of the man page.\n>\n> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n> ---\n\nHm.  What does \"git notes prune -q\" do?\n\nThe docs describe what --dry-run and --verbose do for \"git notes prune\"\nbut its description of --quiet seems to be specific to \"git notes\nmerge\".  Should the usage summary be\n\n git notes [--ref=<notes-ref>] prune [-n] [-v]\n\ninstead?  That would also be consistent with \"git notes prune -h\":\n\n  $ git notes prune -h\n  usage: git notes prune [<options>]\n\n      -n, --dry-run         do not remove, show only\n      -v, --verbose         report pruned notes\n\nThanks,\nJonathan\n"},{"id":"333114","messageId":"alpine.LFD.2.21.1711211328070.4528@localhost.localdomain","threadId":"47275","inReplyTo":"20171121175846.GB27041@aiede.mtv.corp.google.com","subject":"Re: [PATCH] notes: fix erroneous \"git notes prune [-n | -v]\" message","fromName":"Robert P. J. Day","fromEmail":"rpjday@crashcourse.ca","sentAt":"2017-11-21T18:34:34Z","receivedAt":"2017-11-21T18:36:02Z","isPatch":true,"sender":{"key":"rpjday@crashcourse.ca","avatar":"https://avatars.githubusercontent.com/u/226084077?v=4"},"body":"On Tue, 21 Nov 2017, Jonathan Nieder wrote:\n\n> Hi,\n>\n> Robert P. J. Day wrote:\n>\n> > It seems clear that the man page SYNPOSIS and the usage message\n> > referring to:\n> >\n> >   git notes prune [-n | -v]\n> >\n> > is incorrect, as \"-n\" (dry run) and \"-v\" (verbose) are not\n> > alternatives, so fix both places to refer to:\n> >\n> >   git notes prune [-n] [-v | -q]\n> >\n> > to match the rest of the man page.\n> >\n> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>\n> > ---\n>\n> Hm.  What does \"git notes prune -q\" do?\n>\n> The docs describe what --dry-run and --verbose do for \"git notes prune\"\n> but its description of --quiet seems to be specific to \"git notes\n> merge\".  Should the usage summary be\n>\n>  git notes [--ref=<notes-ref>] prune [-n] [-v]\n>\n> instead?  That would also be consistent with \"git notes prune -h\":\n>\n>   $ git notes prune -h\n>   usage: git notes prune [<options>]\n>\n>       -n, --dry-run         do not remove, show only\n>       -v, --verbose         report pruned notes\n\n  you're right ... i'm just getting familiar with the whole\nparse-options.h stuff, and confused OPT__VERBOSE with OPT__VERBOSITY:\n\n  #define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', \"verbose\", (var), (h))\n  #define OPT__QUIET(var, h)    OPT_COUNTUP('q', \"quiet\",   (var), (h))\n  #define OPT__VERBOSITY(var) \\\n        { OPTION_CALLBACK, 'v', \"verbose\", (var), NULL, N_(\"be more verbose\"), \\\n          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \\\n        { OPTION_CALLBACK, 'q', \"quiet\", (var), NULL, N_(\"be more quiet\"), \\\n          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }\n\nso it should simply be corrected to:\n\n  git notes prune [-n] [-v]\n\nsound about right?\n\nrday\n\n-- \n\n========================================================================\nRobert P. J. Day                                 Ottawa, Ontario, CANADA\n                        http://crashcourse.ca\n\nTwitter:                                       http://twitter.com/rpjday\nLinkedIn:                               http://ca.linkedin.com/in/rpjday\n========================================================================\n"},{"id":"333116","messageId":"20171121183850.GB3429@aiede.mtv.corp.google.com","threadId":"47275","inReplyTo":"alpine.LFD.2.21.1711211328070.4528@localhost.localdomain","subject":"Re: [PATCH] notes: fix erroneous \"git notes prune [-n | -v]\" message","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-11-21T18:38:50Z","receivedAt":"2017-11-21T18:38:57Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Robert P. J. Day wrote:\n\n> so it should simply be corrected to:\n>\n>   git notes prune [-n] [-v]\n>\n> sound about right?\n\nSounds good to me.\n\nThanks for finding these confusing docs, by the way.\n\nJonathan\n"}]}