git notes command

Git Basic Operations

git notesThe command allows users to add additional notes to commits.

Notes do not modify the content of the commit; instead, they are attached to the commit's metadata, making it convenient to record extra information such as review remarks, additional explanations, and so on.

Syntax

The basic syntax of the git notes command is as follows:

git notes <subcommand> [options] [arguments]
  • <subcommand>: Specific operation subcommands (such asadd, show, list, remove, edit, mergeetc.).
  • [options]: Command options or parameters.
  • [arguments]: Additional parameters for the command, such as the commit hash, etc.

Command usage instructions:

  • git notes add: Add new comments to the commit.

    • -m: Specify the content of the comment.
    • <commit-hash>: Specifies the commit to which notes are to be added (optional, defaults to the current commit).

  • git notes show: Show the comment for the commit.

    • <commit-hash>: Specifies the commit whose notes are to be displayed (optional, defaults to the current commit).

  • git notes list: Lists the notes of all commits on the current branch.

  • git notes remove: Delete the comment for the commit.

    • <commit-hash>: Specifies the commit from which notes are to be removed (optional, defaults to all notes).

  • git notes edit: Edit the comment for the commit. Withgit notes addSimilar to the above, but opens the default editor in edit mode for editing notes.

  • git notes merge: Merges different note records. This is used to resolve note conflicts during merges.

  • refs/notes/*: Used to specify the reference path for notes. Used for pushing and pulling notes.

Example

1. Add comment

# 添加注释到当前提交
git notes add -m "This commit fixes the login bug"

# 添加注释到特定提交
git notes add -m "Added new feature X" <commit-hash>

2. View comments

# 查看当前提交的注释
git notes show

# 查看特定提交的注释
git notes show <commit-hash>

3. List all comments

# 列出当前分支上所有提交的注释
git notes list

4. Delete comment

# 删除特定提交的注释
git notes remove <commit-hash>

# 删除所有注释（不常用）
git notes remove

5. Edit comment

# 修改当前提交的注释
git notes edit

6. Push and pull comments

# 推送注释到远程仓库
git push origin refs/notes/*

# 拉取远程注释
git fetch origin refs/notes/*:refs/notes/*

Git Basic Operations

other extensions