Was sollte in der Git-Beschreibungsdatei sein?

77

Nach dem Initialisieren eines neuen lokalen Repos ist eine descriptionDatei vorhanden.

Wofür wird es verwendet und wie soll ich es formatieren? Oder ist es einfach eine lokale Hilfsdatei.

Dieser Thread Der Zugriff auf die Beschreibungsdatei von git schlägt einen Stil vor, aber keine Manpage oder andere Hinweise darauf, warum es so sein sollte, wie es ist.

git Philip Oakley
quelle

Antworten:

58

description Datei wird nur vom GitWeb-Programm verwendet (um die Beschreibung des Repos auf der GitWeb-Seite anzuzeigen)

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

Ansonsten bleibt es Ihnen überlassen, wie Sie es verwenden, und ich sehe keinen Punkt in einem "Stil" dafür.

Manojlds
quelle
Es scheint ab Abschnitt 5.5 im aktuellen PDF zu sein, aber es ist alles nützlich.
Philip Oakley
Daher sollte gesagt werden: Diese Datei wird im Allgemeinen nicht für einen lokalen Klon ausgefüllt. Sie verwenden es normalerweise in einem nackten Repository für das gesegnete Repository, in dem die Git-Web-GUI Repository-Informationen liest (z. B. GitWeb und dergleichen).
Baptiste Mathus
1
GitBlit scheint es auch zu benutzen.
Craig McQueen
50

Die descriptionDatei kann auch von Hook-Skripten oder anderen Skripten gelesen werden, die sich auf das Repository beziehen. Ein beliebtes Hook-Skript, Post-Receive-Email , sendet beispielsweise eine E-Mail an alle Mitglieder, wenn ein Commit für das Repository vorgenommen wird, und verwendet den Inhalt der descriptionDatei als Namen des Repositorys im E-Mail-Betreff.

Mindthief
quelle
1
Der Vollständigkeit halber wird nur die erste Zeile vom Haken verwendet. Oh ja, und ich habe nicht gefunden, ob der Rest der Datei tatsächlich irgendwo angezeigt wird ...: - |
Mars
2
Ein weiteres Tool, das diese Datei verwendet, ist git2html, das auf statischen Sites nützlich ist. Ich denke, das fällt unter Ihre "Skripte im Zusammenhang mit dem Repository" Dach :)
Warbo
6

description ist nur eine Textdatei, die im Web-Frontend als Projektbeschreibung angezeigt wird.

Schreiben Sie dort einfach etwas, das erklärt, worum es im Repository geht.

jkj
quelle
2

Der Inhalt dieser Datei wird auch von gitolite mit dem Befehl "desc -ld" verwendet.

Sie können diese Datei ändern, aber es scheint mir nicht, dass sie als festgeschrieben betrachtet wird.

jmarcio
quelle
Um die Beschreibung auf einem Capitolite-Server festzulegen oder zu ändern, verwenden Sie ssh:ssh git@host desc <repo> <description string>
Harald Albers