git description文件中应该包含什么？

77

初始化新的本地存储库后，将存在一个description文件。

它的作用是什么，应如何格式化？还是仅仅是本地帮助文件。

这个访问git的`description'文件的线程建议一种样式，但是没有手册页或其他引用说明为什么应该如此。

git

— 菲利普·奥克利
source

58

description 文件仅由GitWeb程序使用（用于在GitWeb页面上显示存储库的描述）

否则，您将如何使用它，而我看不到它的“样式”要点。

— Manojlds
source

它似乎在当前pdf的5.5节及以后版本中，但都非常有用。

— 菲利普·奥克利

因此，应该告诉您：实际上，该文件实际上并未填充到本地克隆中。您通常在裸存储库中使用该存储库，其中是Git Web GUI从中读取存储库信息的有祝福的存储库（例如，确实是GitWeb等）。

— Baptiste Mathus 2015年

1

GitBlit似乎也使用它。

— Craig McQueen

50

该description文件还可以通过钩子脚本或其他脚本有关存储库中读取。例如，一种流行的挂钩脚本post-receive-email，在对存储库进行提交时向所有成员发送一封电子邮件，并使用description文件的内容作为电子邮件主题中存储库的名称。

— 窃贼
source

1

为了完整起见，该钩子仅使用第一行。哦，是的，我还没有发现文件的其余部分是否实际显示在任何地方...：-|

— 火星人

2

另一个使用此文件的工具是git2html，它在静态站点上非常有用。我认为这属于您的“与存储库相关的脚本” ：)

— Warbo

6

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

只需在其中写一些东西来解释存储库的含义。

— k
source

2

gitolite还可通过“ desc -ld”命令使用此文件的内容。

您可以修改此文件，但是在我看来，并没有考虑将其提交。

— Jmarcio
source

要在gitolite服务器上设置或修改描述，请使用ssh：ssh git@host desc <repo> <description string>

— Harald Albers