Журнализация изменений проекта

Журнализация изменений проекта

Журнализа́ция измене́ний прое́кта (англ. changelog) представляет собой программное протоколирование изменений, вносимых в большой проект. Таким проектом может быть веб-сайт или проект программного обеспечения. Обычно записи журнала изменений содержат информацию об исправлении ошибок, о новых возможностях и т.д. Большинство проектов с открытым кодом содержат журнал изменений, как один из файлов верхнего уровня.

Каноническим именем для файлов изменений является ChangeLog,[1] но иногда его называют CHANGES или HISTORY (NEWS обычно называют файлы, отражающие изменения версий, а не протоколирование изменений). Некоторые программы сопровождения проектов добавляют к имени файла суффикс .txt.

Некоторые системы управления версиями способны генерировать соответствующую информацию, которая подходит для журнализации изменений.

Содержание

Формат

Файлы изменений организованы в соответствии с пунктами, которые определяют уникальные изменения в функции или файле. Большинство файлов изменений имеют следующий формат:[2]

YYYY-MM-DD  John Doe  <johndoe@example.com>

    * myfile.ext (myfunction): my changes made
    additional changes

    * myfile.ext (unrelated_change): my changes made
    to myfile.ext but completely unrelated to the above

    * anotherfile.ext (somefunction): more changes

Обратите внимание, что между датой и именем и затем между именем и адресом электронной почты есть пробелы. Правилом являются также заключений адреса электронной почты в кавычки < и >. Такие дополнительные записи в журнал изменений добавляет редактор Emacs.

Журнализация изменений в Википедии

Большинство программного обеспечения проекта Wiki включает журнал изменений как основополагающую характеристику (часто он в этом контексте называется историей). Так, например, ссылка «История» в верхней части окна Википедии позволяет перейти на страницу журнала изменений данной статьи. Эта функция жизненно важна для соблюдения требований атрибуции некоторых авторских лицензий.

См. также

Примечания

  1. ↑ The GNU automake manual
  2. ↑ GNU Coding Standards: Style of Change Logs

Ссылки


Wikimedia Foundation. 2010.

Игры ⚽ Нужна курсовая?

Полезное


Смотреть что такое "Журнализация изменений проекта" в других словарях:

  • Журнализация транзакций — Журнализация изменений  функция СУБД, которая сохраняет информацию, необходимую для восстановления базы данных в предыдущее консистентное состояние в случае логических или физических отказов. В простейшем случае журнализация изменений… …   Википедия

  • Журналирование — процесс записи информации о происходящих с каким то объектом (или в рамках какого то процесса) событиях в журнал (например, в файл). Также часто называется аудит. Например, применения стенографирования можно считать разновидностью журналирования …   Википедия

  • The Word (ПО) — У этого термина существуют и другие значения, см. The Word (значения). «The Word» Тип Библейское ПО Разработчики Costas Stergiou. Версия 3.0x …   Википедия

  • README-файл — (от англ. read me  «прочти меня»)  текстовый файл, содержащий информацию о других файлах в том же каталоге или архиве; такой файл обычно сопровождает дистрибутив программы при распространении. Такой файл обычно имеет имя readme.txt …   Википедия

  • Microsoft SQL Server — Тип Реляционная СУБД Разработчик Sybase, Ashton Tate, Microsoft …   Википедия


Поделиться ссылкой на выделенное

Прямая ссылка:
… Нажмите правой клавишей мыши и выберите «Копировать ссылку»