mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-11-23 02:25:39 +01:00
825ebd483f
Conflicts:
mbedtls.doxyfile - PROJECT_NAME - mbed TLS v2.16.6 chosen.
doc_mainpage.h - mbed TLS v2.16.6 version chosen.
hmac_drbg.h - line 260, extended description chosen.
- line 313, extended description chosen.
- line 338, extended description chosen.
version.h - 2.16.6 chosen.
CMakeLists.txt - 2.16.6 chosen.
test_suite_version.data - 2.16.6 chosen.
Makefile - 141 - manual correction - baremetal version of C_SOURCE_FILES
with variables for directories plus 2.16.6 CTAGS addition.
pkparse.c - lines 846 onwards - the asn1_get_nonzero_mpi implementation chosen.
ssl_tls.c - line 5269 - edited manually, left the ret=0, because baremetal has
a different behaviour since commit 87b5626, but added a debug
message that's new in 2.16.6.
all.sh:
- component_build_deprecated - chosen the refactored version from 2.16.6,
but with extra flags from baremetal.
- rest of the _no_xxx tests - merged make options to have PTHREAD=1 and
other changes from 2.16.6 (like -O1 instead of -O0).
- component_build_arm_none_eabi_gcc_no_64bit_multiplication - added
TINYCRYPT_BUILD=0 to the 2.16.6 version of make.
x509/req_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/crl_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/cert_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_mail_client.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_pthread_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_fork_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client1.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client2.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
- line 132 - new options of both branches added.
- skip close notify handled as in 2.16.6, but with `ssl` instead of `&ssl`.
- Merged the 2.16.6 usage split with additional baremetal usages.
- Merged options from baremetal and 2.16.6.
ssl_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_server2.c - Merged the 2.16.6 usage split with additional baremetal usages.
config.pl - fixed missing defines from the documentation, removed duplicates,
and reorganised so that the documentation and excluded list
are ordered in the same way.
test_suite_x509parse.data - only added the two new pathlen tests.
x509_crt.c - change the return code by removing
MBEDTLS_ERR_X509_INVALID_EXTENSIONS, since it's added by
x509_crt_frame_parse_ext not by an "or", but by "+=".
Changelog - Assigned all entries to appropriate sections.
ssl-opt.sh - line 8263 - merged options.
- removed lines 1165 - 1176 - there was a duplicate test, probably
an artifact of previous merges.
check-files.py - sticked to old formatting.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
# Pending changelog entry directory
|
|
|
|
This directory contains changelog entries that have not yet been merged
|
|
to the changelog file ([`../ChangeLog`](../ChangeLog)).
|
|
|
|
## Changelog entry file format
|
|
|
|
A changelog entry file must have the extension `*.txt` and must have the
|
|
following format:
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Security
|
|
* Change description.
|
|
* Another change description.
|
|
|
|
Features
|
|
* Yet another change description. This is a long change description that
|
|
spans multiple lines.
|
|
* Yet again another change description.
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The permitted changelog entry categories are as follows:
|
|
<!-- Keep this synchronized with STANDARD_CATEGORIES in assemble_changelog.py! -->
|
|
|
|
API changes
|
|
Default behavior changes
|
|
Requirement changes
|
|
New deprecations
|
|
Removals
|
|
Features
|
|
Security
|
|
Bugfix
|
|
Changes
|
|
|
|
Use “Changes” for anything that doesn't fit in the other categories, such as
|
|
performance, documentation and test improvements.
|
|
|
|
## How to write a changelog entry
|
|
|
|
Each entry starts with three spaces, an asterisk and a space. Continuation
|
|
lines start with 5 spaces. Lines wrap at 79 characters.
|
|
|
|
Write full English sentences with proper capitalization and punctuation. Use
|
|
the present tense. Use the imperative where applicable. For example: “Fix a
|
|
bug in mbedtls_xxx() ….”
|
|
|
|
Include GitHub issue numbers where relevant. Use the format “#1234” for an
|
|
Mbed TLS issue. Add other external references such as CVE numbers where
|
|
applicable.
|
|
|
|
Credit the author of the contribution if the contribution is not a member of
|
|
the Mbed TLS development team. Also credit bug reporters where applicable.
|
|
|
|
**Explain why, not how**. Remember that the audience is the users of the
|
|
library, not its developers. In particular, for a bug fix, explain the
|
|
consequences of the bug, not how the bug was fixed. For a new feature, explain
|
|
why one might be interested in the feature. For an API change or a deprecation,
|
|
explain how to update existing applications.
|
|
|
|
See [existing entries](../ChangeLog) for examples.
|
|
|
|
## How `ChangeLog` is updated
|
|
|
|
Run [`../scripts/assemble_changelog.py`](../scripts/assemble_changelog.py)
|
|
from a Git working copy
|
|
to move the entries from files in `ChangeLog.d` to the main `ChangeLog` file.
|