Änderungsprotokoll
Ein Änderungsprotokoll, englisch Changelog, ist ein Protokoll oder eine Aufzeichnung von Änderungen an einem Projekt wie beispielsweise einer Software oder einer Website, wo es somit zur Softwaredokumentation zählt.[1] Das Wort Changelog ist ein aus dem Englischen übernommenes Kompositum, das sich aus englisch change für Änderung und log für Logbuch zusammensetzt.
Die meisten Open-Source-Projekte beinhalten eine Changelog-Datei in ihren Distributionen.[1] Diese Datei heißt oftmals CHANGELOG, CHANGES, HISTORY, RELEASE-NOTES oder seltener WHATS.NEW oder NEWS. Meist handelt es sich um eine reine Textdatei.[2] Vor allem im Windows-Bereich wird diesen Dateien manchmal auch die Dateiendung .txt angehängt.
Versionsverwaltungssoftware ist meist in der Lage, aus den Dateiänderungen Changelogs zu produzieren. Auch Wikis stellen mit ihren Versionsgeschichten eine Übersicht aller Änderungen dar.[3]
Mit einer Logdatei hat ein Changelog prinzipiell nichts gemeinsam – es handelt sich zwar bei beiden um Textdateien; während Ersteres zum Protokollieren von Ereignissen oder Prozessen benutzt wird und dabei meistens jede Zeile ein Ereignis darstellt, enthält letzteres Text, der nicht zur maschinellen Weiterverarbeitung gedacht ist, sondern menschenlesbar gestaltet sein soll.[4]
Beispiele
BearbeitenSiehe auch
BearbeitenWeblinks
Bearbeiten
- Jim Blandy: Maintaining the ChangeLog – Artikel über den Aufbau und die Wartung von Changelogs (engl.)
- Aus den GNU Coding Standards: Change Logs – Vorstellung des Konzeptes und empfohlene Standards (engl.)
- Keep a Changelog – Formatierungsempfehlung mit Markdown (mehrsprachig)
Einzelnachweise
Bearbeiten- ↑ a b Kai Chen, Stephen R. Schach, Liguo Yu, Jeff Offutt, Gillian Z. Heller: Open-Source Change Logs. 2004 (psu.edu [abgerufen am 16. Februar 2021]).
- ↑ Style of Change Logs (GNU Coding Standards). Abgerufen am 16. Februar 2021.
- ↑ Lokal siehe Spezial:Letzte Änderungen.
- ↑ Keep a Changelog. Abgerufen am 16. Februar 2021.