що повинно бути у файлі опису git?

77

Після ініціалізації нового локального репо є descriptionфайл.

Для чого він використовується і як слід його форматувати? Або це просто локальний допоміжний файл.

Цей потік Доступ до файлу `` опису '' git пропонує один стиль, але жодної сторінки користувача чи іншого посилання на те, чому він повинен бути таким, яким він є.

git

— Філіп Оклі
джерело

58

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

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

В іншому випадку, як ви ним користуєтесь, залишається вам, і я не бачу сенсу в "стилі" для цього.

— manojlds
джерело

Здається, це знаходиться в розділі 5.5 і далі у поточному pdf, але це все корисно.

— Philip Oakley

Отже, слід сказати: цей файл справді зазвичай не заповнюється для локального клону. Зазвичай ви використовуєте його в голому сховищі для благословенного сховища, де веб-графічний інтерфейс Git читає інформацію про сховища (скажімо, GitWeb та подібні).

— Baptiste Mathus

1

GitBlit також, схоже, використовує його.

— Крейг МакКвін

50

descriptionФайл може бути прочитаний з допомогою гаків сценаріїв або інших сценаріїв , що відносяться до сховища. Наприклад, один популярний сценарій підключення, електронна пошта після отримання , надсилає електронне повідомлення всім учасникам при здійсненні коміту до сховища та використовує вміст descriptionфайлу як ім'я сховища в темі електронної пошти.

— розумовий злодій
джерело

1

Для повноти гачком використовується лише перша лінія. О так, і я не знайшов, чи решта файлів насправді десь відображається ...: - |

— Марсіан

2

Іншим інструментом, який використовує цей файл, є git2html, який корисний на статичних сайтах. Я думаю, що це потрапляє під парасольку "сценаріїв, що стосуються сховища" :)

— Warbo

6

description - це просто текстовий файл, який відображається як опис проекту у веб-інтерфейсі.

Просто напишіть там щось, що пояснює, про що сховище.

— jkj
джерело

2

Вміст цього файлу також використовується gitolite з командою "desc -ld".

Ви можете змінити цей файл, але мені не здається, що це враховано, щоб бути здійсненим.

— jmarcio
джерело

Щоб встановити або змінити опис на сервері гітоліту, використовуйте ssh:ssh git@host desc <repo> <description string>

— Harald Albers