什么应该在git描述文件中?

时间:2011-07-28 23:06:55

标签: git

初始化新的本地仓库后,会出现description个文件。

它用于什么以及如何格式化?或者它只是一个本地帮助文件。

这个帖子Accessing git's `description' file建议一种风格,但没有人工页面或其他参考,为什么它应该是这样的。

4 个答案:

答案 0 :(得分:51)

description文件仅供GitWeb程序使用(在GitWeb页面上显示repo的描述)

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

否则,你如何使用它留给你,我没有看到它的“风格”点。

答案 1 :(得分:46)

钩子脚本或与存储库有关的其他脚本也可以读取description文件。例如,一个流行的钩子脚本post-receive-email在向存储库提交时向所有成员发送电子邮件,并使用description文件的内容作为电子邮件中存储库的名称主题。

答案 2 :(得分:6)

description 只是一个文本文件,在Web前端显示为项目描述。

只需写一些解释存储库内容的东西。

答案 3 :(得分:1)

这个文件的内容也被gitolite用于" desc -ld"命令。

您可以修改此文件,但在我看来,它并未考虑提交。