Document the behavior or the new --notes, --notes=<ref> and --no-notes options, and list --show-notes[=<ref>] and --[no-]standard-notes options as deprecated. Signed-off-by: Johan Herland <johan@xxxxxxxxxxx> --- On Tuesday 29 March 2011, Johan Herland wrote: > On Tuesday 29 March 2011, Jeff King wrote: > > Here's the series I ended up with. Getting the refactoring just right > > turned out to be non-trivial, but between several attempts and some > > tests, I think the end result is correct. Hopefully the breakdown of > > the changes into small patches helps make it easy to review. > > > > [1/6]: notes: make expand_notes_ref globally accessible > > [2/6]: revision.c: refactor notes ref expansion > > [3/6]: notes: refactor display notes extra refs field > > [4/6]: notes: refactor display notes default handling > > [5/6]: revision.c: support --notes command-line option > > [6/6]: revision.c: make --no-notes reset --notes list > > Indeed, the whole series looks good to me. > > Acked-by: Johan Herland <johan@xxxxxxxxxxx> And here's some documentation to go on top. Have fun! :) ...Johan Documentation/git-log.txt | 4 ++-- Documentation/pretty-options.txt | 32 ++++++++++++++++++++++---------- 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index ff41784..0c1c10e 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -177,9 +177,9 @@ May be an unabbreviated ref name or a glob and may be specified multiple times. A warning will be issued for refs that do not exist, but a glob that does not match any refs is silently ignored. + -This setting can be disabled by the `--no-standard-notes` option, +This setting can be disabled by the `--no-notes` option, overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable, -and supplemented by the `--show-notes` option. +and supplemented by the `--notes=<ref>` option. Author ------ diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 50923e2..a9b399b 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -30,19 +30,31 @@ people using 80-column terminals. preferred by the user. For non plumbing commands this defaults to UTF-8. ---no-notes:: ---show-notes[=<ref>]:: +--notes[=<ref>]:: Show the notes (see linkgit:git-notes[1]) that annotate the commit, when showing the commit log message. This is the default for `git log`, `git show` and `git whatchanged` commands when - there is no `--pretty`, `--format` nor `--oneline` option is - given on the command line. + there is no `--pretty`, `--format` nor `--oneline` option given + on the command line. ++ +By default, the notes shown are from the notes refs listed in the +'core.notesRef' and 'notes.displayRef' variables (or corresponding +environment overrides). See linkgit:git-config[1] for more details. + -With an optional argument, add this ref to the list of notes. The ref -is taken to be in `refs/notes/` if it is not qualified. +With an optional '<ref>' argument, add this notes ref to the list of +notes refs to be shown. The ref is taken to be in `refs/notes/` if it +is not qualified. +--no-notes:: + Do not show notes. This negates the above `--notes` option, by + resetting the list of notes refs from which notes are shown. + This can be combined with the above `--notes` option to control + exactly which notes refs are shown. E.g. "--notes=foo" will show + notes, both from the default notes ref, and from "refs/notes/foo", + while "--no-notes --notes=foo" will only show notes from + "refs/notes/foo". + +--show-notes[=<ref>]:: --[no-]standard-notes:: - Enable or disable populating the notes ref list from the - 'core.notesRef' and 'notes.displayRef' variables (or - corresponding environment overrides). Enabled by default. - See linkgit:git-config[1]. + These options are deprecated. Use the above --notes/--no-notes + options instead. -- 1.7.4 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html