<commit_before><!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<builder name="CFile">
<summary>
Builds a C source file given a lex (<filename>.l</filename>)
or yacc (<filename>.y</filename>) input file.
The suffix specified by the &cv-link-CFILESUFFIX; construction variable
(<filename>.c</filename> by default)
is automatically added to the target
if it is not already present.
Example:

<example>
# builds foo.c
env.CFile(target = 'foo.c', source = 'foo.l')
# builds bar.c
env.CFile(target = 'bar', source = 'bar.y')
</example>
</summary>
</builder>

<builder name="CXXFile">
<summary>
Builds a C++ source file given a lex (<filename>.ll</filename>)
or yacc (<filename>.yy</filename>)
input file.
The suffix specified by the &cv-link-CXXFILESUFFIX; construction variable
(<filename>.cc</filename> by default)
is automatically added to the target
if it is not already present.
Example:

<example>
# builds foo.cc
env.CXXFile(target = 'foo.cc', source = 'foo.ll')
# builds bar.cc
env.CXXFile(target = 'bar', source = 'bar.yy')
</example>
</summary>
</builder>

<builder name="Library">
<summary>
A synonym for the
&b-StaticLibrary;
builder method.
</summary>
</builder>

<builder name="LoadableModule">
<summary>
On most systems,
this is the same as
&b-SharedLibrary;.
On Mac OS X (Darwin) platforms,
this creates a loadable module bundle.
</summary>
</builder>

<builder name="Object">
<summary>
A synonym for the
&b-StaticObject;
builder method.
</summary>
</builder>

<builder name="Program">
<summary>
Builds an executable given one or more object files
or C, C++, D, or Fortran source files.
If any C, C++, D or Fortran source files are specified,
then they will be automatically
compiled to object files using the
&b-Object;
builder method;
see that builder method's description for
a list of legal source file suffixes
and how they are interpreted.
The target executable file prefix
(specified by the &cv-link-PROGPREFIX; construction variable; nothing by default)
and suffix
(specified by the &cv-link-PROGSUFFIX; construction variable;
by default, <filename>.exe</filename> on Windows systems,
nothing on POSIX systems)
are automatically added to the target if not already present.
Example:

<example>
env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f'])
</example>
</summary>
</builder>

<builder name="SharedLibrary">
<summary>
Builds a shared library
(<filename>.so</filename> on a POSIX system,
<filename>.dll</filename> on Windows)
given one or more object files
or C, C++, D or Fortran source files.
If any source files are given,
then they will be automatically
compiled to object files.
The static library prefix and suffix (if any)
are automatically added to the target.
The target library file prefix
(specified by the &cv-link-SHLIBPREFIX; construction variable;
by default, <filename>lib</filename> on POSIX systems,
nothing on Windows systems)
and suffix
(specified by the &cv-link-SHLIBSUFFIX; construction variable;
by default, <filename>.dll</filename> on Windows systems,
<filename>.so</filename> on POSIX systems)
are automatically added to the target if not already present.
Example:

<example>
env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'])
</example>

On Windows systems, the
&b-SharedLibrary;
builder method will always build an import
(<filename>.lib</filename>) library
in addition to the shared (<filename>.dll</filename>) library,
adding a <filename>.lib</filename> library with the same basename
if there is not already a <filename>.lib</filename> file explicitly
listed in the targets.

Any object files listed in the
<literal>source</literal>
must have been built for a shared library
(that is, using the
&b-SharedObject;
builder method).
&scons;
will raise an error if there is any mismatch.

On some platforms, there is a distinction between a shared library
(loaded automatically by the system to resolve external references)
and a loadable module (explicitly loaded by user action).
For maximum portability, use the &b-LoadableModule; builder for the latter.

When the &cv-link-SHLIBVERSION; construction variable is defined a versioned
shared library is created. This modifies the &cv-link-SHLINKFLAGS; as required.
adds the version number to the library name, and creates the symlinks that 
are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X 
and Y are numbers, and Z is a number but can also contain letters to designate
alpha, beta, or release candidate patch levels.

This builder may create multiple links to the library. On a POSIX system, 
for the shared library libbar.so.2.3.1, the links created would be 
libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system 
the library would be libbar.2.3.1.dylib and the link would be 
libbar.dylib.

On Windows systems, specifying
<literal>register=1</literal>
will cause the <filename>.dll</filename> to be<commit_msg>Fix typo, change period to comma<commit_after><!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<builder name="CFile">
<summary>
Builds a C source file given a lex (<filename>.l</filename>)
or yacc (<filename>.y</filename>) input file.
The suffix specified by the &cv-link-CFILESUFFIX; construction variable
(<filename>.c</filename> by default)
is automatically added to the target
if it is not already present.
Example:

<example>
# builds foo.c
env.CFile(target = 'foo.c', source = 'foo.l')
# builds bar.c
env.CFile(target = 'bar', source = 'bar.y')
</example>
</summary>
</builder>

<builder name="CXXFile">
<summary>
Builds a C++ source file given a lex (<filename>.ll</filename>)
or yacc (<filename>.yy</filename>)
input file.
The suffix specified by the &cv-link-CXXFILESUFFIX; construction variable
(<filename>.cc</filename> by default)
is automatically added to the target
if it is not already present.
Example:

<example>
# builds foo.cc
env.CXXFile(target = 'foo.cc', source = 'foo.ll')
# builds bar.cc
env.CXXFile(target = 'bar', source = 'bar.yy')
</example>
</summary>
</builder>

<builder name="Library">
<summary>
A synonym for the
&b-StaticLibrary;
builder method.
</summary>
</builder>

<builder name="LoadableModule">
<summary>
On most systems,
this is the same as
&b-SharedLibrary;.
On Mac OS X (Darwin) platforms,
this creates a loadable module bundle.
</summary>
</builder>

<builder name="Object">
<summary>
A synonym for the
&b-StaticObject;
builder method.
</summary>
</builder>

<builder name="Program">
<summary>
Builds an executable given one or more object files
or C, C++, D, or Fortran source files.
If any C, C++, D or Fortran source files are specified,
then they will be automatically
compiled to object files using the
&b-Object;
builder method;
see that builder method's description for
a list of legal source file suffixes
and how they are interpreted.
The target executable file prefix
(specified by the &cv-link-PROGPREFIX; construction variable; nothing by default)
and suffix
(specified by the &cv-link-PROGSUFFIX; construction variable;
by default, <filename>.exe</filename> on Windows systems,
nothing on POSIX systems)
are automatically added to the target if not already present.
Example:

<example>
env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f'])
</example>
</summary>
</builder>

<builder name="SharedLibrary">
<summary>
Builds a shared library
(<filename>.so</filename> on a POSIX system,
<filename>.dll</filename> on Windows)
given one or more object files
or C, C++, D or Fortran source files.
If any source files are given,
then they will be automatically
compiled to object files.
The static library prefix and suffix (if any)
are automatically added to the target.
The target library file prefix
(specified by the &cv-link-SHLIBPREFIX; construction variable;
by default, <filename>lib</filename> on POSIX systems,
nothing on Windows systems)
and suffix
(specified by the &cv-link-SHLIBSUFFIX; construction variable;
by default, <filename>.dll</filename> on Windows systems,
<filename>.so</filename> on POSIX systems)
are automatically added to the target if not already present.
Example:

<example>
env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'])
</example>

On Windows systems, the
&b-SharedLibrary;
builder method will always build an import
(<filename>.lib</filename>) library
in addition to the shared (<filename>.dll</filename>) library,
adding a <filename>.lib</filename> library with the same basename
if there is not already a <filename>.lib</filename> file explicitly
listed in the targets.

Any object files listed in the
<literal>source</literal>
must have been built for a shared library
(that is, using the
&b-SharedObject;
builder method).
&scons;
will raise an error if there is any mismatch.

On some platforms, there is a distinction between a shared library
(loaded automatically by the system to resolve external references)
and a loadable module (explicitly loaded by user action).
For maximum portability, use the &b-LoadableModule; builder for the latter.

When the &cv-link-SHLIBVERSION; construction variable is defined a versioned
shared library is created. This modifies the &cv-link-SHLINKFLAGS; as required,
adds the version number to the library name, and creates the symlinks that 
are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X 
and Y are numbers, and Z is a number but can also contain letters to designate
alpha, beta, or release candidate patch levels.

This builder may create multiple links to the library. On a POSIX system, 
for the shared library libbar.so.2.3.1, the links created would be 
libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system 
the library would be libbar.2.3.1.dylib and the link would be 
libbar.dylib.

On Windows systems, specifying
<literal>register=1</literal>
will cause the <filename>.dll</filename> to be
{'fraction_non_alphanumeric': 0.10371190021124635, 'fraction_numerical': 0.0020118700331958556, 'mean_word_length': 4.928443649373882, 'pattern_counts': {'":': 0, '<': 149, '<?xml version=': 0, '>': 149, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5881105', 'n_tokens_mistral': 2963, 'n_tokens_neox': 2875, 'n_words': 1302}