2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 13:37:55 +00:00

[#3522] Modify docs

This commit is contained in:
Slawek Figiel
2024-08-01 17:28:46 +02:00
parent fc7b9a72a4
commit 52186764d1

View File

@@ -18,12 +18,17 @@ unique for all merge requests.
The content of the file should omit the entry number. The format is: The content of the file should omit the entry number. The format is:
@code{.unparsed} @code{.unparsed}
[category][* if the changes are backward incompatible] [author] {category}{* if the changes are backward incompatible} {author}
[multi-line description, indented] {multi-line description, indented}
[GL issue number, indented] {GL issue number, indented}
[optional empty line] {empty line}
@endcode @endcode
The category must be surrounded by square brackets. The list of categories is
available in the ChangeLog file. The backward incompatible change is marked by
an asterisk. The author may contain multiple names delimited by a comma
followed by a space.
The GitLab issue number must be constructed as follows: The GitLab issue number must be constructed as follows:
@code{.unparsed} @code{.unparsed}
@@ -48,4 +53,4 @@ The release engineer commits the updated ChangeLog file (with the merged
unreleased entries) and deletes content of the changelog_unreleased unreleased entries) and deletes content of the changelog_unreleased
directory. directory.
*/ */