1. ホーム
  2. git

[解決済み] git description ファイルには何を書くべきですか?

2023-07-10 17:12:50

質問

新しいローカルリポジトリを初期化した後に description ファイルが存在します。

これは何に使われ、どのようにフォーマットすればよいのでしょうか。それとも単にローカルヘルパーファイルなのでしょうか。

このスレッド git の `description' ファイルにアクセスする は一つのスタイルを提案していますが、なぜそのようにすべきなのかについての man ページや他の参照はありません。

どのように解決するのですか?

description ファイルは、GitWeb プログラムでのみ使用されます (GitWeb ページにリポジトリの説明を表示するため)。

https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain

それ以外の使い方は自由ですし、そのための"style"の意味もないと思っています。