Merge branch 'jk/notes-dwim-doc' into maint
authorJunio C Hamano <gitster@pobox.com>
Fri, 16 Oct 2015 21:32:40 +0000 (14:32 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 16 Oct 2015 21:32:40 +0000 (14:32 -0700)
The way how --ref/--notes to specify the notes tree reference are
DWIMmed was not clearly documented.

* jk/notes-dwim-doc:
notes: correct documentation of DWIMery for notes references

1  2 
Documentation/git-notes.txt
index a9a916f360ec9efb8a801acc982ba39a38f41cf5,b8889ecf1c963bda1da8faf4439b75cc6a1d48a5..8de349968a3be4ea7e65a4a254041b0f0fb63347
@@@ -101,7 -101,7 +101,7 @@@ merge:
        any) into the current notes ref (called "local").
  +
  If conflicts arise and a strategy for automatically resolving
 -conflicting notes (see the -s/--strategy option) is not given,
 +conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given,
  the "manual" resolver is used. This resolver checks out the
  conflicting notes in a special worktree (`.git/NOTES_MERGE_WORKTREE`),
  and instructs the user to manually resolve the conflicts there.
@@@ -162,7 -162,9 +162,9 @@@ OPTION
  --ref <ref>::
        Manipulate the notes tree in <ref>.  This overrides
        'GIT_NOTES_REF' and the "core.notesRef" configuration.  The ref
-       is taken to be in `refs/notes/` if it is not qualified.
+       specifies the full refname when it begins with `refs/notes/`; when it
+       begins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed
+       to form a full name of the ref.
  
  --ignore-missing::
        Do not consider it an error to request removing notes from an
        When merging notes, resolve notes conflicts using the given
        strategy. The following strategies are recognized: "manual"
        (default), "ours", "theirs", "union" and "cat_sort_uniq".
 +      This option overrides the "notes.mergeStrategy" configuration setting.
        See the "NOTES MERGE STRATEGIES" section below for more
        information on each notes merge strategy.
  
@@@ -248,9 -249,6 +250,9 @@@ When done, the user can either finaliz
  'git notes merge --commit', or abort the merge with
  'git notes merge --abort'.
  
 +Users may select an automated merge strategy from among the following using
 +either -s/--strategy option or configuring notes.mergeStrategy accordingly:
 +
  "ours" automatically resolves conflicting notes in favor of the local
  version (i.e. the current notes ref).
  
@@@ -314,20 -312,6 +316,20 @@@ core.notesRef:
        This setting can be overridden through the environment and
        command line.
  
 +notes.mergeStrategy::
 +      Which merge strategy to choose by default when resolving notes
 +      conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
 +      `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
 +      section above for more information on each strategy.
 ++
 +This setting can be overridden by passing the `--strategy` option.
 +
 +notes.<name>.mergeStrategy::
 +      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.
 +
  notes.displayRef::
        Which ref (or refs, if a glob or specified more than once), in
        addition to the default set by `core.notesRef` or
@@@ -349,8 -333,7 +351,8 @@@ environment variable
  notes.rewriteMode::
        When copying notes during a rewrite, what to do if the target
        commit already has a note.  Must be one of `overwrite`,
 -      `concatenate`, and `ignore`.  Defaults to `concatenate`.
 +      `concatenate`, `cat_sort_uniq`, or `ignore`.  Defaults to
 +      `concatenate`.
  +
  This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
  environment variable.
@@@ -387,7 -370,7 +389,7 @@@ does not match any refs is silently ign
  'GIT_NOTES_REWRITE_MODE'::
        When copying notes during a rewrite, what to do if the target
        commit already has a note.
 -      Must be one of `overwrite`, `concatenate`, and `ignore`.
 +      Must be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
        This overrides the `core.rewriteMode` setting.
  
  'GIT_NOTES_REWRITE_REF'::