diff options
author | Mats Wichmann <mats@linux.com> | 2020-06-17 15:35:54 (GMT) |
---|---|---|
committer | Mats Wichmann <mats@linux.com> | 2020-06-17 15:35:54 (GMT) |
commit | f468300f5adf2092ccd50f534e5b6636aa5dfad7 (patch) | |
tree | 95f48758dcf47ed7af34bcd447ae8f702e4a9483 | |
parent | da65f970f87b700ef6270159e529421793795f52 (diff) | |
download | SCons-f468300f5adf2092ccd50f534e5b6636aa5dfad7.zip SCons-f468300f5adf2092ccd50f534e5b6636aa5dfad7.tar.gz SCons-f468300f5adf2092ccd50f534e5b6636aa5dfad7.tar.bz2 |
Fix docbook 4.5 vs 5 usage [ci skip]
Recent changes introduced the use of the Docbook 5 syntax for external
links (<link xlink:href="https://www.example.com"/>), which works okay
for the doc build, but breaks the internal tools which do formal validation
against the scons-modified docbook DTD ("sconsdoc") because sconsdoc is
a modification of Docbook 4.5 thus pinning us to that version.
xlink was a Docbook 5 introduction to use more standard W3C syntax
for the links (xlink is a W3C spec of its own).
Back off this new usage: go back to the old usage pattern
(<ulink url="https://www.example.com">), because trying to uplift
sconsdoc looks a fairly substantial task.
Signed-off-by: Mats Wichmann <mats@linux.com>
-rw-r--r-- | SCons/Platform/__init__.py | 4 | ||||
-rw-r--r-- | doc/man/scons.xml | 11 | ||||
-rw-r--r-- | doc/user/main.xml | 1 | ||||
-rw-r--r-- | doc/user/misc.xml | 4 |
4 files changed, 9 insertions, 11 deletions
diff --git a/SCons/Platform/__init__.py b/SCons/Platform/__init__.py index e2a7b1e..4c912d4 100644 --- a/SCons/Platform/__init__.py +++ b/SCons/Platform/__init__.py @@ -56,9 +56,9 @@ import SCons.Tool def platform_default(): - r"""Return the platform string for our execution environment. + """Return the platform string for our execution environment. - The returned value should map to one of the SCons/Platform/*.py + The returned value should map to one of the SCons/Platform/\*.py files. Since scons is architecture independent, though, we don't care about the machine architecture. """ diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 6b77a4c..18e4321 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -41,7 +41,6 @@ <reference xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xlink="http://www.w3.org/1999/xlink" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <referenceinfo> @@ -7448,22 +7447,22 @@ and will silently revert to non-cached behavior in such cases.</para> <simplelist type="vert"> <member> The SCons User Guide at - <link xlink:href="https://scons.org/doc/production/HTML/scons-user.html"/> + <ulink url="https://scons.org/doc/production/HTML/scons-user.html"/> </member> <member>The SCons Design Document (old)</member> <member> The SCons Cookbook at - <link xlink:href="https://scons-cookbook.readthedocs.io"/> + <ulink url="https://scons-cookbook.readthedocs.io"/> for examples of how to solve various problems with &SCons;. </member> <member> SCons source code - <link xlink:href="https://github.com/SCons/scons"> - on GitHub</link> + <ulink url="https://github.com/SCons/scons"> + on GitHub</ulink> </member> <member> The SCons API Reference - <link xlink:href="https://scons.org/doc/production/HTML/scons-api/index.html"/> + <ulink url="https://scons.org/doc/production/HTML/scons-api/index.html"/> (for internal details) </member> </simplelist> diff --git a/doc/user/main.xml b/doc/user/main.xml index dded9cf..19d7071 100644 --- a/doc/user/main.xml +++ b/doc/user/main.xml @@ -62,7 +62,6 @@ <book xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xlink="http://www.w3.org/1999/xlink" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <bookinfo> <title>SCons &buildversion;</title> diff --git a/doc/user/misc.xml b/doc/user/misc.xml index bd20397..3a2713a 100644 --- a/doc/user/misc.xml +++ b/doc/user/misc.xml @@ -685,9 +685,9 @@ env.Command('directory_build_info', </para> <para> See - <link xlink:href="https://clang.llvm.org/docs/JSONCompilationDatabase.html"> + <ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html"> <citetitle>JSON Compilation Database Format Specification</citetitle> - </link> + </ulink> for complete information </para> |