что должно быть в файле описания git? - PullRequest
69 голосов
/ 29 июля 2011

После инициализации нового локального репо присутствует файл description.

Для чего он используется и как его отформатировать? Или это просто локальный вспомогательный файл.

Эта тема Доступ к файлу `` описания '' git предлагает один стиль, но нет справочной страницы или другой ссылки на то, почему так должно быть.

Ответы [ 4 ]

52 голосов
/ 29 июля 2011

description файл используется только программой GitWeb (для отображения описания репо на странице GitWeb)

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

В противном случае, как вы используете его, остается за вами, и я не вижу смысла в "стиле" для этого.

46 голосов
/ 30 мая 2012

Файл description также может быть прочитан подключаемыми сценариями или другими сценариями, относящимися к хранилищу.Например, один популярный хук-скрипт, post-receive-email , отправляет электронное письмо всем участникам, когда в хранилище делается коммит, и использует содержимое файла description в качестве именихранилище в теме письма.

6 голосов
/ 29 июля 2011

description - это просто текстовый файл, который отображается как описание проекта в веб-интерфейсе.

Просто напишите туда что-нибудь, что объясняет, что такое хранилище.

1 голос
/ 04 ноября 2017

Содержимое этого файла также используется gitolite с командой "desc -ld".

Вы можете изменить этот файл, но мне не кажется, что он принимается во внимание для принятия.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...