Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename debug to ssl_debug + make it internal #6859

Open
mpg opened this issue Dec 30, 2022 · 0 comments
Open

Rename debug to ssl_debug + make it internal #6859

mpg opened this issue Dec 30, 2022 · 0 comments
Labels
api-break This issue/PR breaks the API and must wait for a new major version deprecation needs deprecation announcement enhancement size-s Estimated task size: small (~2d)

Comments

@mpg
Copy link
Contributor

mpg commented Dec 30, 2022

The debug module, currently debug.h + debug.c is not about generic debugging but actually part of SSL. It's the only part of SSL that doesn't start with ssl_, so this should be fixed by renaming to ssl_debug. (Once this is done, all parts of libmbedtls.a will start with ssl_ and all parts of libmbedx509.a with x509_, so once crypto is split out everything will be neat and tidy.)

Also, it's unclear is most of whats currently in debug.h is really meant as a public API for applications to use, or only for internal use by the library. IMO only mbedtls_debug_set_threshold() should really be public and everything else internal. If we go this way, then we might want to move its declaration to ssl.h (and rename to mbedtls_ssl_debug_set_threshold() while at it), and then have no public ssl_debug.h, just an internal one in library.

Similarly MBEDTLS_DEBUG_C should be renamed MBEDTLS_SSL_DEBUG_C for consistency.

@mpg mpg added enhancement api-break This issue/PR breaks the API and must wait for a new major version size-s Estimated task size: small (~2d) labels Dec 30, 2022
@daverodgman daverodgman added the deprecation needs deprecation announcement label Aug 7, 2023
@mpg mpg changed the title Rename debug to ssl_debug Rename debug to ssl_debug + make it internal Jun 6, 2024
@yanesca yanesca moved this to Implementation needed in Mbed TLS 4.0 planning Jun 24, 2024
@github-project-automation github-project-automation bot moved this to Mbed TLS 4.0 COULD in Backlog for Mbed TLS Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-break This issue/PR breaks the API and must wait for a new major version deprecation needs deprecation announcement enhancement size-s Estimated task size: small (~2d)
Projects
Status: Mbed TLS 4.0 COULD
Status: Implementation needed
Development

No branches or pull requests

2 participants