Document check-config.h and *adjust*.h as internal headers #9061
Conversation
Including *adjust*.h directly is likely to cause them to be applied at the wrong time, resulting in an invalid or unintended configuration. Including check_config.h at the wrong time is likely to cause spurious errors. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
gilles-peskine-arm
added
enhancement
needs-review
gilles-peskine-arm
added
approved
| @@ -2,6 +2,8 @@ | |||
| * \file mbedtls/config_adjust_legacy_crypto.h | |||
| * \brief Adjust legacy configuration configuration | |||
| * | |||
| * This is an internal header. Do not include it directly. | |||
There was a problem hiding this comment.
Note: #9057 adds a new adjust file. If it gets merged first, we need to ensure that it follows the template that we're changing here.
There was a problem hiding this comment.
Mentioned PR has been merged and it looks like the internal header warning will cleanly apply on top of it.
gilles-peskine-arm
added
needs-work
and removed
approved
|
Although 7f19db5 has been approved, there is more work to do:
Since the discussion around the enforcement is more sensitive in 3.6 LTS, I intend to wait until #9146 is approved, then do the rebase and forward-port to |
| @@ -2,6 +2,8 @@ | |||
| * \file mbedtls/config_adjust_legacy_crypto.h | |||
| * \brief Adjust legacy configuration configuration | |||
| * | |||
| * This is an internal header. Do not include it directly. | |||
There was a problem hiding this comment.
Mentioned PR has been merged and it looks like the internal header warning will cleanly apply on top of it.
| @@ -0,0 +1,6 @@ | |||
| Changes | |||
| * Explicitly state that mbedtls/check_config.h must not be included manually. | |||
There was a problem hiding this comment.
Shouldn't we change the cording in accordance to this PR from the backports?
There was a problem hiding this comment.
I'll forward-port once the 3.6 PR has been approved.
It's technically possible to
#includethose headers, so users are doing it, and then complaining about the consequences. Resolve #9147.PR checklist
Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")