Что должно быть в файле описания git?
После инициализации нового локального репо есть файл description
.
Для чего он используется и как его форматировать? Или это просто локальный вспомогательный файл.
Этот поток Доступ к файлу git` описание предлагает один стиль, но ни одна страница руководства или другая ссылка на то, почему это должно быть так, как есть.
Ответы
Ответ 1
description
файл используется только программой GitWeb (для отображения описания репо на странице GitWeb)
https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain
В противном случае, как вы его используете, вам остается, и я не вижу смысла в этом стиле.
Ответ 2
Файл description
также может быть прочитан сценариями крюка или другими скриптами, относящимися к репозиторию. Например, один популярный hook script, post-receive-email, отправляет электронное письмо всем членам при совершении фиксации в репозитории и использует содержимое файла description
в качестве имени репозитория в элементе электронной почты.
Ответ 3
описание - это просто текстовый файл, который отображается как описание проекта в веб-интерфейсе.
Просто напишите там что-то, что объясняет, что такое репозиторий.
Ответ 4
Содержимое этого файла также используется gitolite с командой "desc -ld".
вы можете изменить этот файл, но мне не кажется, что он учитывается для совершения.