From cf0b881803c3d9564b4ebaace212fd5f1435001a Mon Sep 17 00:00:00 2001 From: David Horstmann Date: Mon, 30 Jan 2023 09:50:59 +0000 Subject: [PATCH] Add docstring for new compile function. Signed-off-by: David Horstmann --- scripts/mbedtls_dev/c_build_helper.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/mbedtls_dev/c_build_helper.py b/scripts/mbedtls_dev/c_build_helper.py index 6d2805759b..9bd17d6082 100644 --- a/scripts/mbedtls_dev/c_build_helper.py +++ b/scripts/mbedtls_dev/c_build_helper.py @@ -90,6 +90,13 @@ int main(void) ''') def compile_c_file(c_filename, exe_filename, include_dirs): + """Compile a C source file with the host compiler. + + * ``c_filename``: the name of the source file to compile. + * ``exe_filename``: the name for the executable to be created. + * ``include_dirs``: a list of paths to include directories to be passed + with the -I switch. + """ # Respect $HOSTCC if it is set cc = os.getenv('HOSTCC', None) if cc is None: