diff --git a/pages/common/git-notes.md b/pages/common/git-notes.md new file mode 100644 index 000000000..7014ea664 --- /dev/null +++ b/pages/common/git-notes.md @@ -0,0 +1,36 @@ +# git notes + +> Add or inspect object notes. +> More information: . + +- List all notes and the objects they are attached to: + +`git notes list` + +- List all notes attached to a given object (defaults to HEAD): + +`git notes list [{{object}}]` + +- Show the notes attached to a given object (defaults to HEAD): + +`git notes show [{{object}}]` + +- Append a note to a specified object (opens the default text editor): + +`git notes append {{object}}` + +- Append a note to a specified object, specifying the message: + +`git notes append --message="{{message_text}}"` + +- Edit an existing note (defaults to HEAD): + +`git notes edit [{{object}}]` + +- Copy a note from one object to another: + +`git notes copy {{source_object}} {{target_object}}` + +- Remove all the notes added to a specified object: + +`git notes remove {{object}}`