git notes 使い方

オブジェクトにノートを加える

ノートは、（コミットメッセージに書くことができなかった）注釈をコミット自体を変更せずに書き加えるために使用される。

コミットにノートを加えるには

git notes add
git notes add HAED~3
git notes add <sha1>

のようにする。コミットの指定を省略した場合は HEAD が対象になる。エディタが起動して入力画面になるので、ノートを入力する。ノートは git log で見ることができる。

git notes

または

git notes list

とするとノートとオブジェクトの sha1 が表示される。

コミットを指定して

git notes list <sha1>

とすると対象のコミットに加えられたノートの sha1 が表示される。

git notes edit
git notes edit HEAD~3
git notes edit <sha1>

のようにすると指定のコミットのノートを編集できる。コミットの指定を省略した場合は HEAD が対象となる。

git notes remove

とすると HEAD のノートを削除する。コミットを指定したい場合は

git notes remove HEAD~3
git notes remove <sha1>

のようにする。

「-m」オプションでノートのメッセージを指定できる。

git notes add -m "New message"

また、ファイルに記述された文字列をノートのメッセージとするには「-F」オプションを使う。

git notes add -F NOTE_MESSAGE.txt