summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/SConstruct46
-rw-r--r--doc/developer/architecture.xml16
-rw-r--r--doc/developer/branches.xml16
-rw-r--r--doc/developer/copyright.xml14
-rw-r--r--doc/developer/cycle.xml16
-rw-r--r--doc/developer/main.xml70
-rw-r--r--doc/developer/packaging.xml16
-rw-r--r--doc/developer/preface.xml16
-rw-r--r--doc/developer/sourcetree.xml16
-rw-r--r--doc/developer/testing.xml16
10 files changed, 183 insertions, 59 deletions
diff --git a/doc/developer/SConstruct b/doc/developer/SConstruct
new file mode 100644
index 0000000..1606a66
--- /dev/null
+++ b/doc/developer/SConstruct
@@ -0,0 +1,46 @@
+#
+# SConstruct file for building SCons documentation.
+#
+
+#
+# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+import os
+
+env = Environment(ENV={'PATH' : os.environ['PATH']},
+ tools=['docbook'],
+ toolpath=['../../src/engine/SCons/Tool'])
+
+has_pdf = False
+if (env.WhereIs('fop') or
+ env.WhereIs('xep')):
+ has_pdf = True
+
+#
+# Create document
+#
+env.DocbookXInclude('developer_xi.xml', 'main.xml')
+env.DocbookXslt('developer.xml', 'developer_xi.xml',
+ xsl='../xslt/to_docbook.xslt')
+env.DocbookHtml('developer.html','developer.xml')
+if has_pdf:
+ env.DocbookPdf('developer.pdf','developer.xml')
diff --git a/doc/developer/architecture.xml b/doc/developer/architecture.xml
index 865c50f..229147c 100644
--- a/doc/developer/architecture.xml
+++ b/doc/developer/architecture.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-architecture"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Architecture</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/branches.xml b/doc/developer/branches.xml
index 7d8950a..ca7ae85 100644
--- a/doc/developer/branches.xml
+++ b/doc/developer/branches.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-branches"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Branches</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/copyright.xml b/doc/developer/copyright.xml
index cb63b18..15a94e3 100644
--- a/doc/developer/copyright.xml
+++ b/doc/developer/copyright.xml
@@ -1,6 +1,16 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<legalnotice xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -30,3 +40,5 @@
</para>
</blockquote>
+
+</legalnotice>
diff --git a/doc/developer/cycle.xml b/doc/developer/cycle.xml
index 2233716..193d9db 100644
--- a/doc/developer/cycle.xml
+++ b/doc/developer/cycle.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-development-cycle"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Development Cycle</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/main.xml b/doc/developer/main.xml
index 8480544..2a3f7e8 100644
--- a/doc/developer/main.xml
+++ b/doc/developer/main.xml
@@ -2,7 +2,7 @@
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -25,9 +25,7 @@
-->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
-[
+<!DOCTYPE sconsdoc [
<!ENTITY % version SYSTEM "../version.xml">
%version;
@@ -35,18 +33,11 @@
<!ENTITY % scons SYSTEM "../scons.mod">
%scons;
- <!ENTITY architecture SYSTEM "architecture.xml">
- <!ENTITY branches SYSTEM "branches.xml">
- <!ENTITY copyright SYSTEM "copyright.xml">
- <!ENTITY cycle SYSTEM "cycle.xml">
- <!ENTITY packaging SYSTEM "packaging.xml">
- <!ENTITY preface SYSTEM "preface.xml">
- <!ENTITY sourcetree SYSTEM "sourcetree.xml">
- <!ENTITY testing SYSTEM "testing.xml">
-
]>
-<book>
+<book xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
<bookinfo>
<title>SCons Developer's Guide &buildversion;</title>
@@ -64,47 +55,24 @@
<holder>Steven Knight</holder>
</copyright>
- <legalnotice>
- &copyright;
- </legalnotice>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
<releaseinfo>version &buildversion;</releaseinfo>
</bookinfo>
- <preface id="chap-preface">
- <title>Preface</title>
- &preface;
- </preface>
-
- <chapter id="chap-development-cycle">
- <title>Development Cycle</title>
- &cycle;
- </chapter>
-
- <chapter id="chap-source-tree">
- <title>Source Tree</title>
- &sourcetree;
- </chapter>
-
- <chapter id="chap-testing">
- <title>Testing</title>
- &testing;
- </chapter>
-
- <chapter id="chap-branches">
- <title>Branches</title>
- &branches;
- </chapter>
-
- <chapter id="chap-packaging">
- <title>Packaging</title>
- &packaging;
- </chapter>
-
- <chapter id="chap-architecture">
- <title>Architecture</title>
- &architecture;
- </chapter>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="preface.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="cycle.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sourcetree.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="testing.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="branches.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="packaging.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="architecture.xml"/>
</book>
diff --git a/doc/developer/packaging.xml b/doc/developer/packaging.xml
index c246b55..681082d 100644
--- a/doc/developer/packaging.xml
+++ b/doc/developer/packaging.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-packaging"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Packaging</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/preface.xml b/doc/developer/preface.xml
index 705ff4a..586739e 100644
--- a/doc/developer/preface.xml
+++ b/doc/developer/preface.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-preface"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Preface</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -173,3 +185,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/sourcetree.xml b/doc/developer/sourcetree.xml
index 3149421..349d66a 100644
--- a/doc/developer/sourcetree.xml
+++ b/doc/developer/sourcetree.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-source-tree"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Source Tree</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
diff --git a/doc/developer/testing.xml b/doc/developer/testing.xml
index b9f0b7d..8891c92 100644
--- a/doc/developer/testing.xml
+++ b/doc/developer/testing.xml
@@ -1,6 +1,18 @@
+<?xml version='1.0'?>
+<!DOCTYPE sconsdoc [
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+]>
+
+<chapter id="chap-testing"
+ xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+<title>Testing</title>
+
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -38,3 +50,5 @@
</para>
</section>
+
+</chapter>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-11 05:32:03 +0000