サブモジュールの登録を抹消するコマンドの説明
「git submodule」コマンドは、「サブモジュール」の登録を抹消することもできます。サブモジュールの登録の抹消
以前紹介したサブモジュールの初期化と反対のことを行います。ですので、すでに初期化済みの「サブモジュール」に対して使用します。
登録が抹消された「サブモジュール」は、未初期化の「サブモジュール」になります。
つまり、「config」ファイルから「サブモジュール」の情報が削除され、「サブモジュール」の「ワーキングディレクトリー」内のファイルが全て削除されます。
サブモジュールの削除は行わない
あくまで初期化済みの「サブモジュール」を未初期化の状態に戻すだけで、「サブモジュール」そのものの削除を行うものではありません。必要であれば再度「サブモジュール」を初期化し、「サブモジュール」を利用することも可能です。
どういう時に利用するか
多くの場合「git submodule」コマンドは、ユーザーが操作対象の「サブモジュール」を指定しない限り、すべての「サブモジュール」に対して操作を行います。この時、未初期化の「サブモジュール」は、操作対象外になります。
ですので、すでに用が済んだ「サブモジュール」を常に操作対象外にしたい時に、「サブモジュール」を未初期化の状態に戻すとよいでしょう。
コマンドのフォーマット
コマンドのフォーマットは以下のようになります。
git submodule <情報出力オプション> deinit <オプション> <ワーキングディレクトリーのパス>
このコマンドの基本的な使い方は、「サブモジュールの登録を抹消し、サブモジュールを未初期化の状態に戻す」を参考にしてください。
情報出力オプション
情報の出力に関するオプションです。いずれのオプションも省略できます。
エラーメッセージのみ出力する(-q, --quiet)
このオプションを指定すると、エラーメッセージのみ出力します。登録の抹消に関するオプション
登録の抹消に関するオプションです。いずれのオプションも省略できます。
強制的に登録を抹消する(-f, --force)
「サブモジュール」の登録を強制的に抹消します。このオプションの使用例は、「強制的にサブモジュールの登録を抹消する」を参考にしてください。
ワーキングディレクトリーのパス
登録を抹消する「サブモジュール」の「ワーキングディレクトリー」のパスを指定します。このオプションは省略できません。
このオプションの使用例は、「サブモジュールの登録を抹消し、サブモジュールを未初期化の状態に戻す」を参考にしてください。