Ubuntu Git その297 - サブモジュールのコミットオブジェクト間のサマリーを表示するコマンドの説明（git submodule）

サブモジュールのコミットオブジェクト間のサマリーを表示する

  「git submodule」コマンドは、「サブモジュール」の「コミットオブジェクト」間のサマリーを表示することができます。


  デフォルトでは、「コミットID」が指す「コミットオブジェクト」と、「サブモジュール」の「HEAD」が指す「コミットオブジェクト」間のサマリーを表示します。

  サマリーとは、コミットメッセージの「コミットタイトル」のことです。

コマンドのフォーマット

  コマンドのフォーマットは以下のようになります。


  このコマンドの基本的な使い方は、「コミットIDとサブモジュールのHEADが指すコミットオブジェクト間のサマリーを表示する」を参考にしてください。

情報出力オプション

  情報の出力に関するオプションです。
  いずれのオプションも省略できます。

  エラーメッセージのみ出力する（-q, --quiet）

    このオプションを指定すると、エラーメッセージのみ出力します。

表示するサマリーの対象に関するオプション

  表示するサマリーの対象に関するオプションです。
  いずれのオプションも省略できます。

  コミットIDとステージングエリアのコミットIDを対象にする（--cached）

    「コミットID」が指す「コミットオブジェクト」と、「ステージングエリア」に追加されている「コミットID」が指す「コミットオブジェクト」間のサマリーを表示します。

    このオプションの使用例は、「コミットIDとステージングエリアに追加されているコミットIDが指すコミットオブジェクト間のサマリーを表示する」を参考にしてください。

  ステージングエリアのコミットIDと、サブモジュールのHEADを対象にする（--files）

    「ステージングエリア」に追加されている「コミットID」が指す「コミットオブジェクト」と、「サブモジュール」の「HEAD」が指す「コミットオブジェクト」間のサマリーを表示します。

    このオプションの使用例は、「ステージングエリアに追加されているコミットIDと、サブモジュールのHEADが指すコミットオブジェクト間のサマリーを表示する」を参考にしてください。

  表示するサマリーの対象に関するオプションを省略した場合

    表示するサマリーの対象に関するオプションを省略した場合、「コミットID」が指す「コミットオブジェクト」と、「サブモジュール」の「HEAD」が指す「コミットオブジェクト」間のサマリーを表示します。

    「コミットIDとサブモジュールのHEADが指すコミットオブジェクト間のサマリーを表示する」を参考にしてください。

サマリー関するオプション

  サマリーに関するオプションです。
  いずれのオプションも省略できます。

  表示するサマリー数の指定（-n, --summary-limit）

    表示するサマリー数を指定します。

    このオプションの使用例は、「表示するサマリー数を指定して、コミットオブジェクト間のサマリーを表示する」を参考にしてください。

コミットオブジェクト 

  「スーパープロジェクト」の「コミットオブジェクト」を指定します。
  指定した「コミットオブジェクト」に含まれる「コミットID」が使用されます。

  「コミットオブジェクト」を指す参照で指定することもでき、 以下の指定方法が利用できます。

1. ブランチ名
2. タグ名
3. コミットオブジェクトの識別子 
4. HEAD

  1.ブランチ名

    ブランチヘッドが指す「コミットオブジェクト」を指定します。

  2.タグ名

    タグが指す「コミットオブジェクト」を指定します。

  3.コミットオブジェクトの識別子

    直接「コミットオブジェクト」の識別子を指定します。
    コミットオブジェクトの識別子は、4文字以上の識別子を入力します。

  4.HEAD

    「HEAD」が指す「コミットオブジェクト」を指定します。
    コミットオブジェクトを省略した場合、「スーパープロジェクト」の「HEAD」が指す「コミットオブジェクト」が使用されます。

  オプションの使用例

    このオプションの使用例は、「コミットオブジェクトを指定して、コミットオブジェクト間のサマリーを表示する」を参考にしてください。

ワーキングディレクトリーのパス

  サマリーを表示したい「サブモジュール」の「ワーキングディレクトリー」のパスを指定します。

  ワーキングディレクトリーのパスを省略した場合

    「ワーキングディレクトリー」のパスを省略した場合、すべての「サブモジュール」がサマリーの表示対象になります。

  サマリーを表示したいサブモジュールのみ指定することも可能

    サマリーを表示したい「サブモジュール」の「ワーキングディレクトリー」のパスを指定して、特定の「サブモジュール」のみサマリーの表示対象にすることも可能です。

    「ワーキングディレクトリー」のパスを指定する例は、「サマリーを表示するサブモジュールを指定して、サマリーを表示する」を参考にしてください。