yuzu-mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-mirror/mbedtls.git synced 2025-12-06 07:12:32 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
mbedtls/ChangeLog.d/00README.md

21 lines
641 B
Markdown
Raw Normal View History

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
This directory contains changelog entries that have not yet been merged
Convert ChangeLog.d/README to markdown Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2020-03-27 19:47:35 +01:00
to the changelog file ([`../ChangeLog`](../ChangeLog)).
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
Convert ChangeLog.d/README to markdown Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2020-03-27 19:47:35 +01:00
A changelog entry file must have the extension `*.txt` and must have the
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
following format:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Switch to the classic Mbed TLS ChangeLog format Instead of working with Markdown format, keep the classic Mbed TLS ChangeLog format, with the classic category names. Keep the classic file name as well. This way there's no risk of breaking third-party scripts that may copy or even parse the changelog file. Accordingly, expect ChangeLog/*.txt files instead of ChangeLog/*.md. This commit completely rewrites the parsing and output code. This commit systematically appends to the existing top version. A subsequent commit will restore the capability of creating a new version. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2020-03-27 19:05:18 +01:00
Security
* Change description.
* Another change description.
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
Switch to the classic Mbed TLS ChangeLog format Instead of working with Markdown format, keep the classic Mbed TLS ChangeLog format, with the classic category names. Keep the classic file name as well. This way there's no risk of breaking third-party scripts that may copy or even parse the changelog file. Accordingly, expect ChangeLog/*.txt files instead of ChangeLog/*.md. This commit completely rewrites the parsing and output code. This commit systematically appends to the existing top version. A subsequent commit will restore the capability of creating a new version. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2020-03-27 19:05:18 +01:00
Features
* Yet another change description.
* Yet again another change description.
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Convert ChangeLog.d/README to markdown Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2020-03-27 19:47:35 +01:00
See `STANDARD_CATEGORIES` in
[`../scripts/assemble_changelog.py`](../scripts/assemble_changelog.py)
for recognized section titles.
Reference in a new issue Copy permalink