git notes: add page (#4042)

Co-authored-by: Iván Hernández Cazorla <ivan@ivanhercaz.com>
client-spec/clarity
Starbeamrainbowlabs 2020-05-13 09:42:18 +01:00 committed by GitHub
parent 7b3a9b20ac
commit 4a1796c3f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 0 deletions

36
pages/common/git-notes.md Normal file
View File

@ -0,0 +1,36 @@
# git notes
> Add or inspect object notes.
> More information: <https://git-scm.com/docs/git-notes>.
- 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}}`