diff --git a/doc/devel/changelog.dox b/doc/devel/changelog.dox index 5ab7894ece..6fb7c7e2f7 100644 --- a/doc/devel/changelog.dox +++ b/doc/devel/changelog.dox @@ -18,12 +18,17 @@ unique for all merge requests. The content of the file should omit the entry number. The format is: @code{.unparsed} -[category][* if the changes are backward incompatible] [author] - [multi-line description, indented] - [GL issue number, indented] -[optional empty line] +{category}{* if the changes are backward incompatible} {author} + {multi-line description, indented} + {GL issue number, indented} +{empty line} @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: @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 directory. -*/ \ No newline at end of file +*/