Skip to content

Commit b4f80a7

Browse files
committed
Address mwichmann's feedback. Annotate with changed version and remove now obsolete note about function prototype
1 parent 04eed99 commit b4f80a7

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

SCons/Conftest.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,9 @@ def CheckFunc(context, function_name, header = None, language = None, funcargs =
244244
Note that this uses the current value of compiler and linker flags, make
245245
sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly.
246246
Returns an empty string for success, an error message for failure.
247+
248+
.. versionchanged:: 4.7.0
249+
The ``funcargs`` parameter was added.
247250
"""
248251

249252
# Remarks from autoconf:

doc/man/scons.xml

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3974,32 +3974,27 @@ If omitted, the default stanza will be
39743974
(with <parameter>function_name</parameter> appropriately substituted):
39753975
</para>
39763976

3977-
<para>
3978-
The optional <parameter>funcargs</parameter> can be defined to specify an argument list for the generated
3979-
function invocation.
3980-
</para>
3981-
39823977
<programlisting language="C">
39833978
#ifdef __cplusplus
39843979
extern "C"
39853980
#endif
39863981
char function_name(void);
39873982
</programlisting>
39883983

3984+
<para>
3985+
The optional <parameter>funcargs</parameter> can be defined to specify an argument list for the generated
3986+
function invocation.
3987+
</para>
3988+
39893989
<para>
39903990
Note: if <parameter>header</parameter> is supplied,
3991-
it should <emphasis>not</emphasis>
3992-
include the standard header file that declares
3993-
<parameter>function_name</parameter>,
3994-
and it <emphasis>should</emphasis> include a
3995-
dummy prototype similar to the default case.
3996-
Compilers reject builds where a function call does
3997-
not match the declared prototype as happens
3998-
if the "real" header is included,
3999-
and modern compilers are now rejecting
4000-
implicit function declarations.
3991+
and the function_name being called takes any parameters, appropriate values for those
3992+
function arguments should be supplied
3993+
by using the <parameter>funcargs</parameter>.
40013994
</para>
40023995

3996+
<emphasis>Changed in version 4.7.0: added the <parameter>funcargs</parameter>.</emphasis>
3997+
40033998
<para>Returns a boolean indicating success or failure.</para>
40043999
</listitem>
40054000
</varlistentry>

0 commit comments

Comments
 (0)