Skip to content

Commit 9c4887a

Browse files
committed
Update man/scons.xml CheckFunc documentation for optional header and funcargs usage. [ci skip]
1 parent 5ffe87e commit 9c4887a

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

CHANGES.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ NOTE: The 4.0.0 Release of SCons dropped Python 2.7 Support
88
NOTE: 4.3.0 now requires Python 3.6.0 and above. Python 3.5.x is no longer supported
99

1010
RELEASE VERSION/DATE TO BE FILLED IN LATER
11+
1112
From Ataf Fazledin Ahamed:
1213
- Use of NotImplemented instead of NotImplementedError for special methods
1314
of _ListVariable class
14-
15+
1516
From Joseph Brill:
16-
- Add an optional argument list string to configure's CheckFunc method so
17-
that the generated function argument list matches the function's
18-
prototype when including a header file. Fixes GH Issue #4320
17+
- Fix issue #4320: add an optional argument list string to configure's CheckFunc
18+
method so that the generated function argument list matches the function's
19+
prototype when including a header file.
1920

2021
From Michał Górny:
2122
- Remove unecessary dependencies on pypi packages from setup.cfg
@@ -25,7 +26,6 @@ RELEASE VERSION/DATE TO BE FILLED IN LATER
2526
statement with stop flag enabled
2627

2728

28-
2929
RELEASE 4.6.0 - Sun, 19 Nov 2023 17:22:20 -0700
3030

3131
From Max Bachmann:

doc/man/scons.xml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3982,15 +3982,14 @@ char function_name(void);
39823982
</programlisting>
39833983

39843984
<para>
3985-
The optional <parameter>funcargs</parameter> can be defined to specify an argument list for the generated
3986-
function invocation.
3987-
</para>
3988-
3989-
<para>
3990-
Note: if <parameter>header</parameter> is supplied,
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>.
3985+
If <parameter>header</parameter> is supplied, it should <emphasis>not</emphasis> include
3986+
the standard header file that declares <parameter>function_name</parameter> and it
3987+
<emphasis>should</emphasis> include a dummy prototype similar to the default case. If
3988+
this is not possible, the optional <parameter>funcargs</parameter> argument can be used
3989+
to specify a string containing an argument list with the same number and type of
3990+
arguments as the prototype. The arguments can simply be constant values of the correct
3991+
type. Modern C/C++ compilers reject implicit function declarations and may also reject
3992+
function calls whose arguments are not type compatible with the prototype.
39943993
</para>
39953994

39963995
<para>

0 commit comments

Comments
 (0)