mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-01-03 23:43:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
Signed-off-by: Gabor Mezei <gabor.mezei@arm.com>
This commit is contained in:
Gabor Mezei 2024-08-06 12:02:18 +02:00
parent b80516816d
commit 9f2b817fa7
No known key found for this signature in database
GPG Key ID: 6310BD29B0BFF98C
1 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/config.py
View File

@ -1,17 +1,12 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""Mbed TLS configuration file manipulation library and tool """Mbed TLS and PSA configuration file manipulation library and tool
Basic usage, to read the Mbed TLS configuration: Basic usage, to read the Mbed TLS configuration:
config = ConfigFile() config = CombinedConfigFile()
if 'MBEDTLS_RSA_C' in config: print('RSA is enabled') if 'MBEDTLS_RSA_C' in config: print('RSA is enabled')
""" """
# Note that as long as Mbed TLS 2.28 LTS is maintained, the version of
# this script in the mbedtls-2.28 branch must remain compatible with
# Python 3.4. The version in development may only use more recent features
# in parts that are not backported to 2.28.
## Copyright The Mbed TLS Contributors ## Copyright The Mbed TLS Contributors
## SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later ## SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
## ##
@ -22,7 +17,7 @@ import re
from abc import ABCMeta from abc import ABCMeta
class Setting: class Setting:
"""Representation of one Mbed TLS mbedtls_config.h setting. """Representation of one Mbed TLS mbedtls_config.h pr PSA crypto_config.h setting.
Fields: Fields:
* name: the symbol name ('MBEDTLS_xxx'). * name: the symbol name ('MBEDTLS_xxx').
@ -41,7 +36,7 @@ class Setting:
self.configfile = configfile self.configfile = configfile
class Config: class Config:
"""Representation of the Mbed TLS configuration. """Representation of the Mbed TLS and PSA configuration.
In the documentation of this class, a symbol is said to be *active* In the documentation of this class, a symbol is said to be *active*
if there is a #define for it that is not commented out, and *known* if there is a #define for it that is not commented out, and *known*