Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git notes: add page #4042

Merged
merged 2 commits into from
May 13, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions pages/common/git-notes.md
Original file line number Diff line number Diff line change
@@ -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}}`