Skip to content

Commit 6cbb718

Browse files
bdbaddogbdbaddog
authored
Merge pull request SCons#4450 from mwichmann/doc/uguide-license
Housekeeping: normalize license info in User Guide
2 parents 9d010f4 + 16b9af6 commit 6cbb718

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+383
-1235
lines changed

‎doc/user/README

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# __COPYRIGHT__
1+
# SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
2+
# SPDX-License-Identifier: MIT
23

34
When adding a new file, add it to main.xml and MANIFEST.
45

56
To build the .xml files from the .in files:
67
scons -D BUILDDOC=1 foo.xml
78
To build the whole PDF doc from this dir, for testing:
8-
scons -D ../../build/doc/PDF/scons-user.pdf
9+
scons -D ../../build/doc/PDF/scons-user.pdf
910

1011
Writing examples: here's a simple template.
1112

‎doc/user/SConstruct

Lines changed: 21 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,36 @@
1+
# SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
2+
# SPDX-License-Identifier: MIT
13
#
24
# SConstruct file for building SCons documentation.
35
#
46

5-
#
6-
# __COPYRIGHT__
7-
#
8-
# Permission is hereby granted, free of charge, to any person obtaining
9-
# a copy of this software and associated documentation files (the
10-
# "Software"), to deal in the Software without restriction, including
11-
# without limitation the rights to use, copy, modify, merge, publish,
12-
# distribute, sublicense, and/or sell copies of the Software, and to
13-
# permit persons to whom the Software is furnished to do so, subject to
14-
# the following conditions:
15-
#
16-
# The above copyright notice and this permission notice shall be included
17-
# in all copies or substantial portions of the Software.
18-
#
19-
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
20-
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
21-
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22-
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
23-
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
24-
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
25-
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26-
277
import os
288

29-
env = Environment(ENV={'PATH' : os.environ['PATH']},
30-
tools=['docbook','gs','zip'],
31-
toolpath=['../../SCons/Tool'],
32-
# DOCBOOK_XSLTPROCFLAGS="--stringparam fop.extensions 1",
33-
DOCBOOK_DEFAULT_XSL_HTML='html.xsl',
34-
DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl',
35-
DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl')
9+
env = Environment(
10+
ENV={'PATH': os.environ['PATH']},
11+
tools=['docbook', 'gs', 'zip'],
12+
toolpath=['../../SCons/Tool'],
13+
# DOCBOOK_XSLTPROCFLAGS="--stringparam fop.extensions 1",
14+
DOCBOOK_DEFAULT_XSL_HTML='html.xsl',
15+
DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl',
16+
DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl',
17+
)
3618

3719
has_pdf = False
38-
if (env.WhereIs('fop') or
39-
env.WhereIs('xep')):
20+
if env.WhereIs('fop') or env.WhereIs('xep'):
4021
has_pdf = True
4122

4223
#
4324
# UserGuide for SCons
4425
#
4526
env.DocbookXInclude('scons_xi.xml', 'main.xml')
46-
env.DocbookXslt('scons_ex.xml', 'scons_xi.xml',
47-
xsl='../xslt/xinclude_examples.xslt')
27+
env.DocbookXslt('scons_ex.xml', 'scons_xi.xml', xsl='../xslt/xinclude_examples.xslt')
4828
env.DocbookXInclude('scons_exi.xml', 'scons_ex.xml')
49-
env.DocbookXslt('scons_db.xml', 'scons_exi.xml',
50-
xsl='../xslt/to_docbook.xslt')
51-
env.DocbookHtml('index.html','scons_db.xml')
29+
env.DocbookXslt('scons_db.xml', 'scons_exi.xml', xsl='../xslt/to_docbook.xslt')
30+
env.DocbookHtml('index.html', 'scons_db.xml')
5231
env.DocbookHtmlChunked('index.html', 'scons_db.xml', base_dir='scons-user/')
5332
if has_pdf:
54-
env.DocbookPdf('scons-user.pdf','scons_db.xml')
33+
env.DocbookPdf('scons-user.pdf', 'scons_db.xml')
5534

5635
has_gs = False
5736
if env.WhereIs('gs'):
@@ -61,7 +40,10 @@ if env.WhereIs('gs'):
6140
# Create the EPUB format
6241
#
6342
if has_gs and has_pdf:
64-
jpg = env.Gs('OEBPS/cover.jpg','scons-user.pdf',
65-
GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -dJPEGQ=100 -r72x72 -q')
43+
jpg = env.Gs(
44+
'OEBPS/cover.jpg',
45+
'scons-user.pdf',
46+
GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -dJPEGQ=100 -r72x72 -q',
47+
)
6648
epub = env.DocbookEpub('scons-user.epub', 'scons_db.xml', xsl='epub.xsl')
6749
env.Depends(epub, jpg)

‎doc/user/actions.xml

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<?xml version='1.0'?>
2+
3+
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
5+
SPDX-License-Identifier: MIT
6+
-->
7+
28
<!DOCTYPE sconsdoc [
39
<!ENTITY % scons SYSTEM "../scons.mod">
410
%scons;
5-
11+
612
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
713
%builders-mod;
814
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
@@ -11,7 +17,7 @@
1117
%tools-mod;
1218
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
1319
%variables-mod;
14-
20+
1521
]>
1622

1723
<chapter id="chap-actions"
@@ -20,31 +26,6 @@
2026
xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
2127
<title>&SCons; Actions</title>
2228

23-
<!--
24-
25-
__COPYRIGHT__
26-
27-
Permission is hereby granted, free of charge, to any person obtaining
28-
a copy of this software and associated documentation files (the
29-
"Software"), to deal in the Software without restriction, including
30-
without limitation the rights to use, copy, modify, merge, publish,
31-
distribute, sublicense, and/or sell copies of the Software, and to
32-
permit persons to whom the Software is furnished to do so, subject to
33-
the following conditions:
34-
35-
The above copyright notice and this permission notice shall be included
36-
in all copies or substantial portions of the Software.
37-
38-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
39-
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
40-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
42-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
43-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
44-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45-
46-
-->
47-
4829
<!--
4930
5031
=head1 Build actions

‎doc/user/add-method.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?xml version='1.0'?>
2+
23
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
35
SPDX-License-Identifier: MIT
4-
5-
Copyright The SCons Foundation
66
-->
77

88
<!DOCTYPE sconsdoc [
99
<!ENTITY % scons SYSTEM "../scons.mod">
1010
%scons;
11-
11+
1212
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
1313
%builders-mod;
1414
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
@@ -17,7 +17,7 @@ Copyright The SCons Foundation
1717
%tools-mod;
1818
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
1919
%variables-mod;
20-
20+
2121
]>
2222

2323
<chapter id="chap-add-method"

‎doc/user/alias.xml

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<?xml version='1.0'?>
2+
3+
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
5+
SPDX-License-Identifier: MIT
6+
-->
7+
28
<!DOCTYPE sconsdoc [
39
<!ENTITY % scons SYSTEM "../scons.mod">
410
%scons;
5-
11+
612
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
713
%builders-mod;
814
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
@@ -11,7 +17,7 @@
1117
%tools-mod;
1218
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
1319
%variables-mod;
14-
20+
1521
]>
1622

1723
<chapter id="chap-alias"
@@ -20,31 +26,6 @@
2026
xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
2127
<title>Alias Targets</title>
2228

23-
<!--
24-
25-
__COPYRIGHT__
26-
27-
Permission is hereby granted, free of charge, to any person obtaining
28-
a copy of this software and associated documentation files (the
29-
"Software"), to deal in the Software without restriction, including
30-
without limitation the rights to use, copy, modify, merge, publish,
31-
distribute, sublicense, and/or sell copies of the Software, and to
32-
permit persons to whom the Software is furnished to do so, subject to
33-
the following conditions:
34-
35-
The above copyright notice and this permission notice shall be included
36-
in all copies or substantial portions of the Software.
37-
38-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
39-
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
40-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
42-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
43-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
44-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45-
46-
-->
47-
4829
<para>
4930

5031
We've already seen how you can use the &Alias;

‎doc/user/ant.xml

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<?xml version='1.0'?>
2+
3+
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
5+
SPDX-License-Identifier: MIT
6+
-->
7+
28
<!DOCTYPE sconsdoc [
39
<!ENTITY % scons SYSTEM "../scons.mod">
410
%scons;
5-
11+
612
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
713
%builders-mod;
814
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
@@ -11,7 +17,7 @@
1117
%tools-mod;
1218
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
1319
%variables-mod;
14-
20+
1521
]>
1622

1723
<appendix id="app-ant"
@@ -20,31 +26,6 @@
2026
xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
2127
<title>Converting From Ant</title>
2228

23-
<!--
24-
25-
__COPYRIGHT__
26-
27-
Permission is hereby granted, free of charge, to any person obtaining
28-
a copy of this software and associated documentation files (the
29-
"Software"), to deal in the Software without restriction, including
30-
without limitation the rights to use, copy, modify, merge, publish,
31-
distribute, sublicense, and/or sell copies of the Software, and to
32-
permit persons to whom the Software is furnished to do so, subject to
33-
the following conditions:
34-
35-
The above copyright notice and this permission notice shall be included
36-
in all copies or substantial portions of the Software.
37-
38-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
39-
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
40-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
42-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
43-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
44-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45-
46-
-->
47-
4829
<para>
4930

5031
XXX

‎doc/user/build-install.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version='1.0'?>
2+
23
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
35
SPDX-License-Identifier: MIT
4-
5-
Copyright The SCons Foundation
66
-->
77

88
<!DOCTYPE sconsdoc [

‎doc/user/builders-built-in.xml

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<?xml version='1.0'?>
2+
3+
<!--
4+
SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
5+
SPDX-License-Identifier: MIT
6+
-->
7+
28
<!DOCTYPE sconsdoc [
39
<!ENTITY % scons SYSTEM "../scons.mod">
410
%scons;
5-
11+
612
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
713
%builders-mod;
814
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
@@ -11,7 +17,7 @@
1117
%tools-mod;
1218
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
1319
%variables-mod;
14-
20+
1521
]>
1622

1723
<chapter id="chap-builders-built-in"
@@ -20,31 +26,6 @@
2026
xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
2127
<title>Built-In Builders</title>
2228

23-
<!--
24-
25-
__COPYRIGHT__
26-
27-
Permission is hereby granted, free of charge, to any person obtaining
28-
a copy of this software and associated documentation files (the
29-
"Software"), to deal in the Software without restriction, including
30-
without limitation the rights to use, copy, modify, merge, publish,
31-
distribute, sublicense, and/or sell copies of the Software, and to
32-
permit persons to whom the Software is furnished to do so, subject to
33-
the following conditions:
34-
35-
The above copyright notice and this permission notice shall be included
36-
in all copies or substantial portions of the Software.
37-
38-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
39-
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
40-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
42-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
43-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
44-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45-
46-
-->
47-
4829
<para>
4930

5031
&SCons; provides the ability to build a lot of different

0 commit comments

Comments
 (0)