ブランチの説明を設定するコマンドの説明
「git branch」コマンドは、既存ブランチの説明を設定することができます。ブランチごとに、ブランチの説明を設定することができます。
この説明は、ブランチの使用目的やブランチの注意事項など、ユーザー向けの説明に使用します。
コマンドのフォーマット
コマンドのフォーマットは以下のようになります。
git branch --edit-description ＜説明を設定するブランチ＞
説明を設定するブランチ
説明を設定するブランチを指定します。このオプションを省略した場合、「HEAD」が指すブランチが指定されます。
ブランチの説明を設定する
ブランチの説明を設定します。1.コマンドの実行
ここでは例として、「master」ブランチの説明を設定します。「端末」から、以下のコマンドを実行します。
git branch --edit-description master
2.テキストエディターの起動
以下のように、テキストエディターが起動します。
デフォルトでは「nano」が起動しますが、使用するテキストエディターはユーザーが設定することもできます。
3.説明の入力
ブランチの説明を入力します。
「#」で始まる行は、コメント行です。
コメント行は説明に反映されません。
説明を入力したら、保存します。
以上で完了です。
4.ブランチの説明
ブランチの説明は、「.git/config」に保存されます。
