gitwrap

Module notes

Source

Functions§

  • abort
    Abort/reset an in-progress git notes merge, i.e. a notes merge with conflicts. This simply removes all files related to the notes merge. –abort
  • allow_empty
    Allow an empty note object to be stored. The default behavior is to automatically remove empty notes. –allow-empty
  • commit
    Finalize an in-progress git notes merge. Use this option when you have resolved the conflicts that git notes merge stored in .git/NOTES_MERGE_WORKTREE. This amends the partial merge commit created by git notes merge (stored in .git/NOTES_MERGE_PARTIAL) by adding the notes in .git/NOTES_MERGE_WORKTREE. The notes ref stored in the .git/NOTES_MERGE_REF symref is updated to the resulting commit. –commit
  • dry_run
    Do not remove anything; just report the object names whose notes would be removed. -n, –dry-run
  • file
    Take the note message from the given file. Use - to read the note message from the standard input. Lines starting with # and empty lines other than a single line between paragraphs will be stripped out. -F , –file=
  • force
    When adding notes to an object that already has notes, overwrite the existing notes (instead of aborting). -f, –force
  • ignore_missing
    Do not consider it an error to request removing notes from an object that does not have notes attached to it. –ignore-missing
  • message
    Use the given note message (instead of prompting). If multiple -m options are given, their values are concatenated as separate paragraphs. Lines starting with # and empty lines other than a single line between paragraphs will be stripped out. -m , –message=
  • notes
  • quiet
    When merging notes, operate quietly. -q, –quiet
  • reedit_message
    Like -C, but with -c the editor is invoked, so that the user can further edit the note message. -c , –reedit-message=
  • ref_notes
    Manipulate the notes tree in . This overrides GIT_NOTES_REF and the “core.notesRef” configuration. The ref 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. –ref
  • reuse_message
    Take the given blob object (for example, another note) as the note message. (Use git notes copy instead to copy notes between objects.) -C , –reuse-message=
  • stdin
    Also read the object names to remove notes from the standard input (there is no reason you cannot combine this with object names from the command line). –stdin
  • strategy
    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. -s , –strategy=
  • verbose
    When merging notes, be more verbose. When pruning notes, report all object names whose notes are removed. -v, –verbose