kledgeb Ubuntuの使い方や日本語化、アプリの使い方を紹介しています。

コミットメッセージを整形して、コミットを行う

  「コミットメッセージ」を整形して、コミットを行います。
  以下の5種類の整形方法が用意されています。

  1. strip
  2. whitespace
  3. verbatim
  4. scissors
  5. default

1.strip

  「strip」では、以下の整形を行います。

  • コミットメッセージの前後にある空白行を削除する
  • 行末の空白文字を削除する
  • コメント行を削除する
  • 連続した空白行を1行の空白行にまとめる

  1-1.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

オプション オプションの値
--cleanup= strip

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --cleanup=strip


  1-2.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    ここでは例として、以下のように「コミットメッセージ」を入力し、ファイルを上書き保存してテキストエディターを終了します。


  1-3.コミットログの確認

   コミットログを確認すると、以下のようになります。


2.whitespace

  「whitespace」では、以下の整形を行います。

  • コミットメッセージの前後にある空白行を削除する
  • 行末の空白文字を削除する
  • コメント行を削除しない
  • 連続した空白行を1行の空白行にまとめる 

  「コメント行を削除しない」点を除いて、「strip」と同じです。

  2-1.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

オプション オプションの値
--cleanup= whitespace

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --cleanup=whitespace


  2-2.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    ここでは例として、以下のように「コミットメッセージ」を入力し、ファイルを上書き保存してテキストエディターを終了します。


  2-3.コミットログの確認

   コミットログを確認すると、以下のようになります。


3.verbatim

  「verbatim」は、「コミットメッセージ」の整形を行いません。

  3-1.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

オプション オプションの値
--cleanup= verbatim

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --cleanup=verbatim


  3-2.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    ここでは例として、以下のように「コミットメッセージ」を入力し、ファイルを上書き保存してテキストエディターを終了します。


  3-3.コミットログの確認

   コミットログを確認すると、以下のようになります。


4.scissors

  「scissors」は、以下の整形を行います。

  • コミットメッセージの前後にある空白行を削除する
  • 行末の空白文字を削除する
  • コメント行を削除しない
  • 連続した空白行を1行の空白行にまとめる 
  • ハサミ行以降の文字列を削除する

  「ハサミ行以降の文字列を削除する」点を除いて、「whitespace」と同じです。
  ただし「ハサミ行以降の文字列を削除する」のは、「コミットメッセージ」の編集画面を表示した時のみです。

  ハサミ行とは(scissors line)

    ハサミ行とは、以下の記述が行われている行のことを指します。

# ------------------------ >8 ------------------------

    ちなみに中央の「>8」は、ハサミを表しています。
    行頭の「#」は、「core.commentChar」設定で変更することができます。

    ハサミ行は、オーサーとコミッターが異なる環境において、コミット時の「コミットメッセージ」には含めたくないが、コミッターに知らせたい内容を「コミットメッセージ」に記述したい時に利用します。

  4-1.コミットメッセージ

    ここでは例として、以下の「コミットメッセージ」を記述したテキストファイルを用意しました。


  4-2.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

オプション オプションの値
--cleanup= scissors

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --cleanup=scissors --file='../CommitMessage.txt' --edit


  4-3.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    ファイルを上書き保存してテキストエディターを終了します。


  4-4.コミットログの確認

   コミットログを確認すると、以下のようになります。


5.default

  「default」は、以下の整形を行います。

  「コミットメッセージ」の編集画面を表示した時は、「strip」と同じ整形を行います。
  「コミットメッセージ」の編集画面を表示しなかった時は、「whitespace」と同じ整形を行います。

   デフォルトの整形方法は、「commit.cleanup」設定で変更できます。

  5-1.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

オプション オプションの値
--cleanup= default

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --cleanup=default


  5-2.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    ここでは例として、以下のように「コミットメッセージ」を入力し、ファイルを上書き保存してテキストエディターを終了します。


  5-3.コミットログの確認

   コミットログを確認すると、以下のようになります。



関連コンテンツ
同一カテゴリーの記事
コメント
オプション