mbedtls/ChangeLog.d
Gilles Peskine 40b3f411ec Changelog merging script
assemble_changelog.py reads changelog entries from ChangeLog.d/*.md
and merges them into ChangeLog.md.

The changelog entries are merged into the first version in
ChangeLog.md. The script does not yet support creating a new version
in ChangeLog.md.

The changelog entries are merged in alphabetical order of the file
names. Future versions of this script are likely to adopt a different
order that reflects the git history of the entries.
2019-10-13 21:44:25 +02:00
..
README Changelog merging script 2019-10-13 21:44:25 +02:00

This directory contains changelog entries that have not yet been merged
to the changelog file (../ChangeLog.md).

A changelog entry file must have the extension *.md and must have the
following format:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
### Section title

* Change descritpion.
* Another change description.

### Another section title

* Yet another change description.
* Yet again another change description.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

See STANDARD_SECTIONS in ../scripts/assemble_changelog.py for
recognized section titles.