diff options
| author | William Deegan <bill@baddogconsulting.com> | 2023-12-11 02:33:22 +0300 |
|---|---|---|
| committer | William Deegan <bill@baddogconsulting.com> | 2023-12-11 02:33:22 +0300 |
| commit | b4f80a79e1e86a4ac0cba1677239ab2251ac5b64 (patch) | |
| tree | 9759ffae7aca49894bf634b4c096a4e5a3dab84a | |
| parent | 04eed99632e36a504cd7c758f0eb09f6bdf641e9 (diff) | |
Address mwichmann's feedback. Annotate with changed version and remove now obsolete note about function prototype
| -rw-r--r-- | SCons/Conftest.py | 3 | ||||
| -rw-r--r-- | doc/man/scons.xml | 25 |
2 files changed, 13 insertions, 15 deletions
diff --git a/SCons/Conftest.py b/SCons/Conftest.py index cd122e7f4..79ede9968 100644 --- a/SCons/Conftest.py +++ b/SCons/Conftest.py @@ -244,6 +244,9 @@ def CheckFunc(context, function_name, header = None, language = None, funcargs = Note that this uses the current value of compiler and linker flags, make sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly. Returns an empty string for success, an error message for failure. + + .. versionchanged:: 4.7.0 + The ``funcargs`` parameter was added. """ # Remarks from autoconf: diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 81a9d0edb..e2e6a57fb 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -3974,11 +3974,6 @@ If omitted, the default stanza will be (with <parameter>function_name</parameter> appropriately substituted): </para> - <para> - The optional <parameter>funcargs</parameter> can be defined to specify an argument list for the generated - function invocation. - </para> - <programlisting language="C"> #ifdef __cplusplus extern "C" @@ -3987,19 +3982,19 @@ char function_name(void); </programlisting> <para> + The optional <parameter>funcargs</parameter> can be defined to specify an argument list for the generated + function invocation. +</para> + +<para> Note: if <parameter>header</parameter> is supplied, -it should <emphasis>not</emphasis> -include the standard header file that declares -<parameter>function_name</parameter>, -and it <emphasis>should</emphasis> include a -dummy prototype similar to the default case. -Compilers reject builds where a function call does -not match the declared prototype as happens -if the "real" header is included, -and modern compilers are now rejecting -implicit function declarations. + and the function_name being called takes any parameters, appropriate values for those + function arguments should be supplied + by using the <parameter>funcargs</parameter>. </para> +<emphasis>Changed in version 4.7.0: added the <parameter>funcargs</parameter>.</emphasis> + <para>Returns a boolean indicating success or failure.</para> </listitem> </varlistentry> |