summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-10-13 07:37:40 -0700
committerChris Johns <chrisj@rtems.org>2017-10-13 07:37:40 -0700
commitb2527535fd5bec6d1167dfe732637fafb0743faf (patch)
treef19ba708573f812b123233a4e14c9359d7a3307e
parent55fcfaa4c2643fe31a572c9bb66f5132089b1a83 (diff)
downloadrtems-docs-b2527535fd5bec6d1167dfe732637fafb0743faf.tar.bz2
posix-compliance: Reference the generated content via the include file.
- Move the copyright to the top of the generated file. - Add a glossary and references section.
-rw-r--r--posix-compliance/glossary.rst7
-rw-r--r--posix-compliance/index.rst12
-rwxr-xr-xposix-compliance/posix_rst.py3
-rw-r--r--posix-compliance/wscript3
-rw-r--r--posix-compliance/zreferences.rst6
5 files changed, 24 insertions, 7 deletions
diff --git a/posix-compliance/glossary.rst b/posix-compliance/glossary.rst
new file mode 100644
index 0000000..811d338
--- /dev/null
+++ b/posix-compliance/glossary.rst
@@ -0,0 +1,7 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+Glossary
+********
+
+.. glossary::
+ :sorted:
diff --git a/posix-compliance/index.rst b/posix-compliance/index.rst
index c825232..5a1cebc 100644
--- a/posix-compliance/index.rst
+++ b/posix-compliance/index.rst
@@ -39,9 +39,13 @@ to the Community Project hosted at http://www.rtems.org/.
================ =============================
.. toctree::
- :maxdepth: 5
- :numbered:
+ :maxdepth: 5
+ :numbered:
- preface
- generated-posix-compliance
+ preface
+ posix-compliance
+ glossary
+ zreferences
+* :ref:`genindex`
+* :ref:`search`
diff --git a/posix-compliance/posix_rst.py b/posix-compliance/posix_rst.py
index b7ad80c..17e4dd9 100755
--- a/posix-compliance/posix_rst.py
+++ b/posix-compliance/posix_rst.py
@@ -98,8 +98,7 @@ cat_columns = {
}
rst_defaults = {
- 'header': ['.. comment SPDX-License-Identifier: CC-BY-SA-4.0',
- '',
+ 'header': ['',
'This chapter has a subsection per header file to detail the methods',
'provided by RTEMS that are in that header file.',
'']
diff --git a/posix-compliance/wscript b/posix-compliance/wscript
index aa3f722..4a940d3 100644
--- a/posix-compliance/wscript
+++ b/posix-compliance/wscript
@@ -17,7 +17,8 @@ def gen_posix_rst(task):
c.load(task.inputs[1].abspath())
s = ['']
for standard in posix_rst.standards:
- s += ['',
+ s += ['.. comment SPDX-License-Identifier: CC-BY-SA-4.0',
+ '',
posix_rst.standard_names[standard],
'*' * len(posix_rst.standard_names[standard]),
''] + c.output(standard)
diff --git a/posix-compliance/zreferences.rst b/posix-compliance/zreferences.rst
new file mode 100644
index 0000000..26b0ed2
--- /dev/null
+++ b/posix-compliance/zreferences.rst
@@ -0,0 +1,6 @@
+.. only:: html
+
+ References
+ **********
+
+.. bibliography:: ../common/refs.bib