author | Junio C Hamano <gitster@pobox.com> | |
Sun, 13 Jun 2010 18:22:39 +0000 (11:22 -0700) | ||
committer | Junio C Hamano <gitster@pobox.com> | |
Sun, 13 Jun 2010 18:22:39 +0000 (11:22 -0700) |
* mg/notes-dry-run:
notes: dry-run and verbose options for prune
notes: dry-run and verbose options for prune
1 | 2 | |||
---|---|---|---|---|
Documentation/git-notes.txt | patch | | diff1 | | diff2 | | blob | history |
diff --cc Documentation/git-notes.txt
index de63ef0745a82136eeee6a2f0993984f2ed2f4ec,0f3279257b9a4972836f88a10a3dd1662d5b6712..5540af5d1667aad16ac11c53593921733c4af56f
the user can further edit the note message.
--ref <ref>::
- Manipulate the notes tree in <ref>. This overrides both
- GIT_NOTES_REF and the "core.notesRef" configuration. The 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.
+ -n::
+ Do not remove anything; just report the object names whose notes
+ would be removed.
+
+ -v::
+ Report all object names whose notes are removed.
+
-NOTES
------
+DISCUSSION
+----------
+
+Commit notes are blobs containing extra information about an object
+(usually information to supplement a commit's message). These blobs
+are taken from notes refs. A notes ref is usually a branch which
+contains "files" whose paths are the object names for the objects
+they describe, with some directory separators included for performance
+reasons footnote:[Permitted pathnames have the form
+'ab'`/`'cd'`/`'ef'`/`'...'`/`'abcdef...': a sequence of directory
+names of two hexadecimal digits each followed by a filename with the
+rest of the object ID.].
Every notes change creates a new commit at the specified notes ref.
You can therefore inspect the history of the notes by invoking, e.g.,