diff options
Diffstat (limited to 'man1/git-notes.1')
-rw-r--r-- | man1/git-notes.1 | 54 |
1 files changed, 39 insertions, 15 deletions
diff --git a/man1/git-notes.1 b/man1/git-notes.1 index c52685d29..d0389f195 100644 --- a/man1/git-notes.1 +++ b/man1/git-notes.1 @@ -2,12 +2,12 @@ .\" Title: git-notes .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 09/13/2022 +.\" Date: 09/14/2022 .\" Manual: Git Manual -.\" Source: Git 2.37.3.611.ge188ec3a73 +.\" Source: Git 2.37.3.662.g36f8e7ed7d .\" Language: English .\" -.TH "GIT\-NOTES" "1" "09/13/2022" "Git 2\&.37\&.3\&.611\&.ge188ec" "Git Manual" +.TH "GIT\-NOTES" "1" "09/14/2022" "Git 2\&.37\&.3\&.662\&.g36f8e7" "Git Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -56,7 +56,7 @@ A typical use of notes is to supplement a commit message without changing the co .sp Notes can also be added to patches prepared with \fBgit format\-patch\fR by using the \fB\-\-notes\fR option\&. Such notes are added as a patch commentary after a three dash separator line\&. .sp -To change which notes are shown by \fIgit log\fR, see the "notes\&.displayRef" configuration in \fBgit-log\fR(1)\&. +To change which notes are shown by \fIgit log\fR, see the "notes\&.displayRef" discussion in the section called \(lqCONFIGURATION\(rq\&. .sp See the "notes\&.rewrite\&.<command>" configuration for a way to carry notes across commands that rewrite commits\&. .SH "SUBCOMMANDS" @@ -310,6 +310,8 @@ core\&.notesRef Notes ref to read and manipulate instead of \fBrefs/notes/commits\fR\&. Must be an unabbreviated ref name\&. This setting can be overridden through the environment and command line\&. .RE +.sp +Everything above this line in this section isn\(cqt included from the \fBgit-config\fR(1) documentation\&. The content that follows is the same as what\(cqs found there: .PP notes\&.mergeStrategy .RS 4 @@ -319,16 +321,21 @@ Which merge strategy to choose by default when resolving notes conflicts\&. Must \fBtheirs\fR, \fBunion\fR, or \fBcat_sort_uniq\fR\&. Defaults to -\fBmanual\fR\&. See "NOTES MERGE STRATEGIES" section above for more information on each strategy\&. +\fBmanual\fR\&. See "NOTES MERGE STRATEGIES" section of +\fBgit-notes\fR(1) +for more information on each strategy\&. .sp This setting can be overridden by passing the \fB\-\-strategy\fR -option\&. +option to +\fBgit-notes\fR(1)\&. .RE .PP notes\&.<name>\&.mergeStrategy .RS 4 -Which merge strategy to choose when doing a notes merge into refs/notes/<name>\&. This overrides the more general "notes\&.mergeStrategy"\&. See the "NOTES MERGE STRATEGIES" section above for more information on each available strategy\&. +Which merge strategy to choose when doing a notes merge into refs/notes/<name>\&. This overrides the more general "notes\&.mergeStrategy"\&. See the "NOTES MERGE STRATEGIES" section in +\fBgit-notes\fR(1) +for more information on the available strategies\&. .RE .PP notes\&.displayRef @@ -338,10 +345,23 @@ Which ref (or refs, if a glob or specified more than once), in addition to the d or \fBGIT_NOTES_REF\fR, to read notes from when showing commit messages with the \fIgit log\fR -family of commands\&. This setting can be overridden on the command line or by the +family of commands\&. +.sp +This setting can be overridden with the \fBGIT_NOTES_DISPLAY_REF\fR -environment variable\&. See -\fBgit-log\fR(1)\&. +environment variable, which must be a colon separated list of refs or globs\&. +.sp +A warning will be issued for refs that do not exist, but a glob that does not match any refs is silently ignored\&. +.sp +This setting can be disabled by the +\fB\-\-no\-notes\fR +option to the +\fIgit log\fR +family of commands, or by the +\fB\-\-notes=<ref>\fR +option accepted by those commands\&. +.sp +The effective value of "core\&.notesRef" (possibly overridden by GIT_NOTES_REF) is also implicitly added to the list of refs to be displayed\&. .RE .PP notes\&.rewrite\&.<command> @@ -353,14 +373,14 @@ or \fBfalse\fR, git will not copy notes from the original to the rewritten commit\&. Defaults to \fBtrue\fR\&. See also "\fBnotes\&.rewriteRef\fR" below\&. .sp -This setting can be overridden by the +This setting can be overridden with the \fBGIT_NOTES_REWRITE_REF\fR -environment variable\&. +environment variable, which must be a colon separated list of refs or globs\&. .RE .PP notes\&.rewriteMode .RS 4 -When copying notes during a rewrite, what to do if the target commit already has a note\&. Must be one of +When copying notes during a rewrite (see the "notes\&.rewrite\&.<command>" option), determines what to do if the target commit already has a note\&. Must be one of \fBoverwrite\fR, \fBconcatenate\fR, \fBcat_sort_uniq\fR, or @@ -376,11 +396,15 @@ notes\&.rewriteRef .RS 4 When copying notes during a rewrite, specifies the (fully qualified) ref whose notes should be copied\&. May be a glob, in which case notes in all matching refs will be copied\&. You may also specify this configuration several times\&. .sp -Does not have a default value; you must configure this variable to enable note rewriting\&. +Does not have a default value; you must configure this variable to enable note rewriting\&. Set it to +\fBrefs/notes/commits\fR +to enable rewriting for the default commit notes\&. .sp Can be overridden with the \fBGIT_NOTES_REWRITE_REF\fR -environment variable\&. +environment variable\&. See +\fBnotes\&.rewrite\&.<command>\fR +above for a further description of its format\&. .RE .SH "ENVIRONMENT" .PP |