Skip to content

Fix DocBook XSD, making it deterministic again #4615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dirkbaechle wants to merge 5 commits into from
Closed

Fix DocBook XSD, making it deterministic again #4615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d52f4fc
Corrected namespace for import in xml.xsd
dirkbaechle Oct 12, 2024
3c52a20
Fixed element hierarchy, except for sconsdoc
dirkbaechle Oct 13, 2024
f86c23e
Re-added sconsdoc and subelements
dirkbaechle Oct 13, 2024
26c4a36
Removed all annotations, unused for now
dirkbaechle Oct 13, 2024
84d383e
Fixed usage of example_commands
dirkbaechle Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ NOTE: Python 3.6 support is deprecated and will be dropped in a future release.

RELEASE VERSION/DATE TO BE FILLED IN LATER

From Dirk Baechle:
- Fixed the grammar of the SCons DocBook XSD, which was reported as being
"not deterministic" by some XML scanners/validators.

From Joseph Brill:
- Added error handling when creating MS VC detection debug log file specified by
SCONS_MSCOMMON_DEBUG
Expand Down
4 changes: 4 additions & 0 deletions SCons/Tool/link.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,9 +400,11 @@ See also &cv-link-LINKFLAGS; for linking static objects.
<summary>
<para>
Variable used to hard-code SONAME for versioned shared library/loadable module.
</para>
<example_commands>
env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SONAME='libtest.so.2')
</example_commands>
<para>
The variable is used, for example, by &t-link-gnulink; linker tool.
</para>
</summary>
Expand All @@ -414,9 +416,11 @@ The variable is used, for example, by &t-link-gnulink; linker tool.
This will construct the <varname>SONAME</varname> using on the base library name
(<parameter>test</parameter> in the example below) and use specified <varname>SOVERSION</varname>
to create <varname>SONAME</varname>.
</para>
<example_commands>
env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SOVERSION='2')
</example_commands>
<para>
The variable is used, for example, by &t-link-gnulink; linker tool.
</para>
<para>
Expand Down
28 changes: 14 additions & 14 deletions SCons/Tool/msvc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -837,10 +837,10 @@ and &cv-link-MSVC_SCRIPT_ARGS; are not allowed.

<para>
Example - A Visual Studio 2022 build for the Universal Windows Platform:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_UWP_APP=True)
</example_commands>
</para>

<para>
Important usage details:
Expand Down Expand Up @@ -1107,33 +1107,34 @@ Note: in addition to the camel case values shown above, lower case and upper cas

<para>
Example 1 - A Visual Studio 2022 build with user-defined script arguments:
</para>
<example_commands>
env = environment(MSVC_VERSION='14.3', MSVC_SCRIPT_ARGS=['8.1', 'store', '-vcvars_ver=14.1'])
env.Program('hello', ['hello.c'], CCFLAGS='/MD', LIBS=['kernel32', 'user32', 'runtimeobject'])
</example_commands>
</para>

<para>
Example 1 - Output fragment:
</para>
<example_commands>
...
link /nologo /OUT:_build001\hello.exe kernel32.lib user32.lib runtimeobject.lib _build001\hello.obj
LINK : fatal error LNK1104: cannot open file 'MSVCRT.lib'
...
</example_commands>
</para>

<para>
Example 2 - A Visual Studio 2022 build with user-defined script arguments and the script error policy set
to issue a warning when msvc batch file errors are detected:
</para>
<example_commands>
env = environment(MSVC_VERSION='14.3', MSVC_SCRIPT_ARGS=['8.1', 'store', '-vcvars_ver=14.1'], MSVC_SCRIPTERROR_POLICY='warn')
env.Program('hello', ['hello.c'], CCFLAGS='/MD', LIBS=['kernel32', 'user32', 'runtimeobject'])
</example_commands>
</para>

<para>
Example 2 - Output fragment:
</para>
<example_commands>
...
scons: warning: vc script errors detected:
Expand All @@ -1144,7 +1145,6 @@ scons: warning: vc script errors detected:
link /nologo /OUT:_build001\hello.exe kernel32.lib user32.lib runtimeobject.lib _build001\hello.obj
LINK : fatal error LNK1104: cannot open file 'MSVCRT.lib'
</example_commands>
</para>

<para>
Important usage details:
Expand Down Expand Up @@ -1265,18 +1265,18 @@ via &cv-link-MSVC_UWP_APP; and &cv-MSVC_SCRIPT_ARGS; are not allowed.
<para>
Example 1 - A Visual Studio 2022 build with an SDK version and a toolset version
specified with a string argument:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_SCRIPT_ARGS='10.0.20348.0 -vcvars_ver=14.29.30133')
</example_commands>
</para>

<para>
Example 2 - A Visual Studio 2022 build with an SDK version and a toolset version
specified with a list argument:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_SCRIPT_ARGS=['10.0.20348.0', '-vcvars_ver=14.29.30133'])
</example_commands>
</para>

<para>
Important usage details:
Expand Down Expand Up @@ -1378,17 +1378,17 @@ must be '14.0').

<para>
Example 1 - A Visual Studio 2022 build with a specific Windows SDK version:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_SDK_VERSION='10.0.20348.0')
</example_commands>
</para>

<para>
Example 2 - A Visual Studio 2022 build with a specific SDK version for the Universal Windows Platform:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_SDK_VERSION='10.0.20348.0', MSVC_UWP_APP=True)
</example_commands>
</para>

<para>
Important usage details:
Expand Down Expand Up @@ -1550,31 +1550,31 @@ toolset with the largest version number.

<para>
Example 1 - A default Visual Studio build with a partial toolset version specified:
</para>
<example_commands>
env = Environment(MSVC_TOOLSET_VERSION='14.2')
</example_commands>
</para>

<para>
Example 2 - A default Visual Studio build with a partial toolset version specified:
</para>
<example_commands>
env = Environment(MSVC_TOOLSET_VERSION='14.29')
</example_commands>
</para>

<para>
Example 3 - A Visual Studio 2022 build with a full toolset version specified:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_TOOLSET_VERSION='14.29.30133')
</example_commands>
</para>

<para>
Example 4 - A Visual Studio 2022 build with an SxS toolset version specified:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_TOOLSET_VERSION='14.29.16.11')
</example_commands>
</para>

<para>
Important usage details:
Expand Down Expand Up @@ -1647,10 +1647,10 @@ components.

<para>
Example - A Visual Studio 2022 build with spectre mitigated &MSVC; libraries:
</para>
<example_commands>
env = Environment(MSVC_VERSION='14.3', MSVC_SPECTRE_LIBS=True)
</example_commands>
</para>

<para>
Important usage details:
Expand Down
10 changes: 5 additions & 5 deletions SCons/Tool/ninja/ninja.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ This file is processed by the bin/SConsDoc.py module
</para>

<!-- NOTE DO NOT INDENT example_commands CONTENTS AS IT WILL ALTER THE FORMATTING-->
<example_commands>
<screen>
# On the command line
--experimental=ninja

# Or in your SConstruct
SetOption('experimental', 'ninja')
</example_commands>
</screen>

<para>This functionality is subject to change and/or removal without deprecation cycle.</para>

Expand All @@ -127,10 +127,10 @@ SetOption('experimental', 'ninja')
<systemitem>import</systemitem> of the package
<!-- (although see &cv-link-__NINJA_NO;).-->
This can be done via:
<example_commands>
python -m pip install ninja
</example_commands>
</para>
<screen>
python -m pip install ninja
</screen>

</note>

Expand Down
Loading