主题
  • 默认模式
  • 浅蓝色模式
  • 淡绿色模式
  • 深夜模式

git notes 命令

Git 基本操作


git notes 命令用于给提交(commit)添加附加注释。

注释不会修改提交的内容,而是附加到提交的元数据中,便于记录额外的信息,如审查备注、额外说明等。


基本语法

git notes 命令的基本语法如下:

git notes <subcommand> [options] [arguments]
  • <subcommand>:具体的操作子命令(如 add, show, list, remove, edit, merge 等)。
  • [options]:命令的选项或参数。
  • [arguments]:命令的附加参数,如提交哈希值等。

命令使用说明:

  • git notes add:将新的注释添加到提交中。
    -m:指定注释的内容。
    <commit-hash>:指定要添加注释的提交(可选,默认为当前提交)。
  • git notes show:显示提交的注释。
    <commit-hash>:指定要显示注释的提交(可选,默认为当前提交)。
  • git notes list:列出当前分支上所有提交的注释。
  • git notes remove:删除提交的注释。
    <commit-hash>:指定要删除注释的提交(可选,默认为所有注释)。
  • git notes edit:编辑提交的注释。与git notes add类似,但在编辑模式下打开默认编辑器进行注释编辑。
  • git notes merge:合并不同的注释记录,这用于解决合并时的注释冲突。
  • refs/notes/*:用于指定注释的引用路径。用于推送和拉取注释。

基本用法

1. 添加注释

给指定提交添加注释(默认添加到最新提交):

# 给最新提交添加注释
git notes add -m "这是一条附加注释"

# 给指定提交添加注释
git notes add -m "修复了XX问题" <commit-hash>

2. 查看注释

查看提交的注释(会显示在提交信息下方):

# 查看最新提交的注释
git log -1

# 只显示注释内容
git notes show <commit-hash>  # 不指定哈希则显示最新提交的注释

3. 列出所有注释

列出当前分支上所有提交的注释:

git notes list  # 列出所有注释

4. 编辑注释

修改已添加的注释:

git notes edit <commit-hash>  # 不指定哈希则编辑最新提交的注释

5. 删除注释

移除提交的注释:

git notes remove <commit-hash>  # 不指定哈希则删除最新提交的注释

6. 传递注释

注释默认不会被pushfetch,需要显式操作:

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

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

7. 使用命名空间

可以创建不同命名空间的注释,避免冲突:

# 在 "review" 命名空间添加注释
git notes --ref=review add -m "代码评审通过" <commit-hash>

# 查看指定命名空间的注释
git notes --ref=review show <commit-hash>

Git 基本操作



评论区 0
发表评论