aboutsummaryrefslogtreecommitdiff
path: root/gcc/ada/doc
diff options
context:
space:
mode:
authorMartin Liska <mliska@suse.cz>2021-06-28 13:53:49 +0200
committerMartin Liska <mliska@suse.cz>2022-11-09 09:00:36 +0100
commit0a543515957ff47feba739e6f71062fb2fb99125 (patch)
treede64363d5fa5b5ea201b9e0369cfbab2a7fe19db /gcc/ada/doc
parent94246daa3efba88d4ae6619f24d737c01ba3dc89 (diff)
downloadgcc-0a543515957ff47feba739e6f71062fb2fb99125.zip
gcc-0a543515957ff47feba739e6f71062fb2fb99125.tar.gz
gcc-0a543515957ff47feba739e6f71062fb2fb99125.tar.bz2
sphinx: ada: port to Sphinx
gcc/ada/ChangeLog: * doc/gnat-style.rst: Moved to... * doc/gnat-style/index.rst: ...here. * doc/gnat_rm.rst: Moved to... * doc/gnat_rm/index.rst: ...here. * doc/gnat_ugn.rst: Moved to... * doc/gnat_ugn/index.rst: ...here. * doc/share/latex_elements.py: Moved to... * doc/share/ada_latex_elements.py: ...here. * gcc-interface/Make-lang.in: * doc/Makefile: Removed. * doc/share/conf.py: Removed. * doc/share/gnu_free_documentation_license.rst: Removed. * gnat-style.texi: Removed. * gnat_rm.texi: Removed. * gnat_ugn.texi: Removed. * doc/gnat-style/conf.py: New file. * doc/gnat-style/gnu_free_documentation_license.rst: New file. * doc/gnat_rm/conf.py: New file. * doc/gnat_rm/gnu_free_documentation_license.rst: New file. * doc/gnat_ugn/conf.py: New file. * doc/gnat_ugn/gnu_free_documentation_license.rst: New file. * doc/share/adabaseconf.py: New file. * doc/gnat_rm/security_hardening_features.rst: Add role. * doc/gnat_ugn/platform_specific_information.rst: Remove duplicate definition of |nbsp|.
Diffstat (limited to 'gcc/ada/doc')
-rw-r--r--gcc/ada/doc/Makefile87
-rw-r--r--gcc/ada/doc/gnat-style/conf.py26
-rw-r--r--gcc/ada/doc/gnat-style/gnu_free_documentation_license.rst1
-rw-r--r--gcc/ada/doc/gnat-style/index.rst (renamed from gcc/ada/doc/gnat-style.rst)2
-rw-r--r--gcc/ada/doc/gnat_rm/conf.py26
-rw-r--r--gcc/ada/doc/gnat_rm/gnu_free_documentation_license.rst1
-rw-r--r--gcc/ada/doc/gnat_rm/index.rst (renamed from gcc/ada/doc/gnat_rm.rst)40
-rw-r--r--gcc/ada/doc/gnat_rm/security_hardening_features.rst2
-rw-r--r--gcc/ada/doc/gnat_ugn/conf.py26
-rw-r--r--gcc/ada/doc/gnat_ugn/gnu_free_documentation_license.rst1
-rw-r--r--gcc/ada/doc/gnat_ugn/index.rst (renamed from gcc/ada/doc/gnat_ugn.rst)22
-rw-r--r--gcc/ada/doc/gnat_ugn/platform_specific_information.rst6
-rw-r--r--gcc/ada/doc/share/ada_latex_elements.py (renamed from gcc/ada/doc/share/latex_elements.py)11
-rw-r--r--gcc/ada/doc/share/adabaseconf.py81
-rw-r--r--gcc/ada/doc/share/conf.py148
-rw-r--r--gcc/ada/doc/share/gnu_free_documentation_license.rst458
16 files changed, 206 insertions, 732 deletions
diff --git a/gcc/ada/doc/Makefile b/gcc/ada/doc/Makefile
deleted file mode 100644
index 4adfd36..0000000
--- a/gcc/ada/doc/Makefile
+++ /dev/null
@@ -1,87 +0,0 @@
-# Makefile for Sphinx documentation
-
-# You can set these variables from the command line.
-SPHINXOPTS = -W
-SPHINXBUILD = DOC_NAME=$* sphinx-build
-PAPER =
-BUILDDIR = build
-SOURCEDIR = .
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) \
- -c $(SOURCEDIR)/share \
- -d $(BUILDDIR)/$*/doctrees \
- $(SOURCEDIR)
-DOC_LIST=gnat_rm gnat_ugn gnat-style
-FMT_LIST=html pdf txt info
-
-.PHONY: help clean
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " DOC_NAME.html to make standalone HTML files"
- @echo " DOC_NAME.pdf to make LaTeX files and run them through pdflatex"
- @echo " DOC_NAME.txt to make text files"
- @echo " DOC_NAME.info to make info files"
- @echo " DOC_NAME.texinfo to make Texinfo files"
- @echo " DOC_NAME.all to build DOC_NAME for all previous formats"
- @echo " all to build all documentations in all formats"
- @echo " html-all same as previous rule but only for HTML format"
- @echo " pdf-all same as previous rule but only for PDF format"
- @echo " txt-all same as previous rule but only for text format"
- @echo " info-all same as previous rule but only for info format"
- @echo " texinfo-all same as previous rule but only for texinfo format"
- @echo ""
- @echo "DOC_NAME should be a documentation name in the following list:"
- @echo " $(DOC_LIST)"
- @echo ""
- @echo "source and location can be overridden using SOURCEDIR and BUILDDIR variables"
-
-clean:
- -rm -rf $(BUILDDIR)
-
-.PHONY: mk_empty_dirs
-mk_empty_dirs:
- mkdir -p share/_static
-
-%.html: mk_empty_dirs
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/$*/html
-
-%.pdf: mk_empty_dirs
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/$*/pdf
- $(MAKE) -C $(BUILDDIR)/$*/pdf all-pdf LATEXOPTS="-interaction=nonstopmode"
-
-%.txt: mk_empty_dirs
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/txt
- $(MAKE) -C $(BUILDDIR)/$*/txt plaintext
-
-%.info: mk_empty_dirs
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/info
- $(MAKE) -C $(BUILDDIR)/$*/info info
-
-%.texinfo: mk_empty_dirs
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/texinfo
- sed -e 's/^@dircategory/@dircategory GNU Ada Tools/g' < $(BUILDDIR)/$*/texinfo/$*.texi > $(BUILDDIR)/../../$*.texi
-
-.PHONY: html-all
-html-all: $(foreach doc, $(DOC_LIST), $(doc).html)
-
-.PHONY: pdf-all
-pdf-all: $(foreach doc, $(DOC_LIST), $(doc).pdf)
-
-.PHONY: txt-all
-txt-all: $(foreach doc, $(DOC_LIST), $(doc).txt)
-
-.PHONY: info-all
-info-all: $(foreach doc, $(DOC_LIST), $(doc).info)
-
-.PHONY: texinfo-all
-texinfo-all: $(foreach doc, $(DOC_LIST), $(doc).texinfo)
-
-%.all:
- $(MAKE) $(foreach fmt, $(FMT_LIST), $*.$(fmt))
-
-.PHONY: all
-all: $(foreach fmt, $(FMT_LIST), $(fmt)-all)
diff --git a/gcc/ada/doc/gnat-style/conf.py b/gcc/ada/doc/gnat-style/conf.py
new file mode 100644
index 0000000..a413d26
--- /dev/null
+++ b/gcc/ada/doc/gnat-style/conf.py
@@ -0,0 +1,26 @@
+# Configuration file for the Sphinx documentation builder.
+
+import sys
+sys.path.append('../share')
+
+from adabaseconf import *
+
+name = 'gnat-style'
+project = 'GNAT Coding Style: A Guide for GNAT Developers'
+authors = 'AdaCore'
+
+set_latex_elements(latex_elements, project)
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+latex_documents = [
+ ('index', f'{name}.tex', project, authors, 'manual'),
+]
+
+texinfo_documents = [
+ ('index', name, project, authors, None, None, None, True)
+]
+
+tags.add(get_gnat_build_type())
+set_common(name, globals())
diff --git a/gcc/ada/doc/gnat-style/gnu_free_documentation_license.rst b/gcc/ada/doc/gnat-style/gnu_free_documentation_license.rst
new file mode 100644
index 0000000..33c62cf
--- /dev/null
+++ b/gcc/ada/doc/gnat-style/gnu_free_documentation_license.rst
@@ -0,0 +1 @@
+.. include:: ../../../../doc/gnu_free_documentation_license.rst
diff --git a/gcc/ada/doc/gnat-style.rst b/gcc/ada/doc/gnat-style/index.rst
index 527e7ba..b942874 100644
--- a/gcc/ada/doc/gnat-style.rst
+++ b/gcc/ada/doc/gnat-style/index.rst
@@ -688,4 +688,4 @@ Program Structure and Compilation Issues
.. index:: krunch.ads file
.. toctree::
- share/gnu_free_documentation_license
+ gnu_free_documentation_license
diff --git a/gcc/ada/doc/gnat_rm/conf.py b/gcc/ada/doc/gnat_rm/conf.py
new file mode 100644
index 0000000..e99d1e6
--- /dev/null
+++ b/gcc/ada/doc/gnat_rm/conf.py
@@ -0,0 +1,26 @@
+# Configuration file for the Sphinx documentation builder.
+
+import sys
+sys.path.append('../share')
+
+from adabaseconf import *
+
+name = 'gnat_rm'
+project = 'GNAT Reference Manual'
+authors = 'AdaCore'
+
+set_latex_elements(latex_elements, project)
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+latex_documents = [
+ ('index', f'{name}.tex', project, authors, 'manual'),
+]
+
+texinfo_documents = [
+ ('index', name, project, authors, None, None, None, True)
+]
+
+tags.add(get_gnat_build_type())
+set_common(name, globals())
diff --git a/gcc/ada/doc/gnat_rm/gnu_free_documentation_license.rst b/gcc/ada/doc/gnat_rm/gnu_free_documentation_license.rst
new file mode 100644
index 0000000..33c62cf
--- /dev/null
+++ b/gcc/ada/doc/gnat_rm/gnu_free_documentation_license.rst
@@ -0,0 +1 @@
+.. include:: ../../../../doc/gnu_free_documentation_license.rst
diff --git a/gcc/ada/doc/gnat_rm.rst b/gcc/ada/doc/gnat_rm/index.rst
index 7743ef8..6c2616a 100644
--- a/gcc/ada/doc/gnat_rm.rst
+++ b/gcc/ada/doc/gnat_rm/index.rst
@@ -39,25 +39,25 @@ GNAT Reference Manual
:numbered:
:maxdepth: 3
- gnat_rm/about_this_guide
- gnat_rm/implementation_defined_pragmas
- gnat_rm/implementation_defined_aspects
- gnat_rm/implementation_defined_attributes
- gnat_rm/standard_and_implementation_defined_restrictions
- gnat_rm/implementation_advice
- gnat_rm/implementation_defined_characteristics
- gnat_rm/intrinsic_subprograms
- gnat_rm/representation_clauses_and_pragmas
- gnat_rm/standard_library_routines
- gnat_rm/the_implementation_of_standard_i_o
- gnat_rm/the_gnat_library
- gnat_rm/interfacing_to_other_languages
- gnat_rm/specialized_needs_annexes
- gnat_rm/implementation_of_specific_ada_features
- gnat_rm/implementation_of_ada_2012_features
- gnat_rm/security_hardening_features
- gnat_rm/obsolescent_features
- gnat_rm/compatibility_and_porting_guide
+ about_this_guide
+ implementation_defined_pragmas
+ implementation_defined_aspects
+ implementation_defined_attributes
+ standard_and_implementation_defined_restrictions
+ implementation_advice
+ implementation_defined_characteristics
+ intrinsic_subprograms
+ representation_clauses_and_pragmas
+ standard_library_routines
+ the_implementation_of_standard_i_o
+ the_gnat_library
+ interfacing_to_other_languages
+ specialized_needs_annexes
+ implementation_of_specific_ada_features
+ implementation_of_ada_2012_features
+ security_hardening_features
+ obsolescent_features
+ compatibility_and_porting_guide
.. raw:: latex
@@ -66,4 +66,4 @@ GNAT Reference Manual
.. toctree::
:maxdepth: 3
- share/gnu_free_documentation_license
+ gnu_free_documentation_license
diff --git a/gcc/ada/doc/gnat_rm/security_hardening_features.rst b/gcc/ada/doc/gnat_rm/security_hardening_features.rst
index d7c02b9..5a1f2d4 100644
--- a/gcc/ada/doc/gnat_rm/security_hardening_features.rst
+++ b/gcc/ada/doc/gnat_rm/security_hardening_features.rst
@@ -1,3 +1,5 @@
+.. role:: switch(samp)
+
.. _Security_Hardening_Features:
***************************
diff --git a/gcc/ada/doc/gnat_ugn/conf.py b/gcc/ada/doc/gnat_ugn/conf.py
new file mode 100644
index 0000000..94e3c07
--- /dev/null
+++ b/gcc/ada/doc/gnat_ugn/conf.py
@@ -0,0 +1,26 @@
+# Configuration file for the Sphinx documentation builder.
+
+import sys
+sys.path.append('../share')
+
+from adabaseconf import *
+
+name = 'gnat_ugn'
+project = "GNAT User's Guide for Native Platforms"
+authors = 'AdaCore'
+
+set_latex_elements(latex_elements, project)
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+latex_documents = [
+ ('index', f'{name}.tex', project, authors, 'manual'),
+]
+
+texinfo_documents = [
+ ('index', name, project, authors, None, None, None, True)
+]
+
+tags.add(get_gnat_build_type())
+set_common(name, globals())
diff --git a/gcc/ada/doc/gnat_ugn/gnu_free_documentation_license.rst b/gcc/ada/doc/gnat_ugn/gnu_free_documentation_license.rst
new file mode 100644
index 0000000..33c62cf
--- /dev/null
+++ b/gcc/ada/doc/gnat_ugn/gnu_free_documentation_license.rst
@@ -0,0 +1 @@
+.. include:: ../../../../doc/gnu_free_documentation_license.rst
diff --git a/gcc/ada/doc/gnat_ugn.rst b/gcc/ada/doc/gnat_ugn/index.rst
index 0ac6876..d3d1dac 100644
--- a/gcc/ada/doc/gnat_ugn.rst
+++ b/gcc/ada/doc/gnat_ugn/index.rst
@@ -40,12 +40,12 @@ GNAT User's Guide for Native Platforms
:maxdepth: 3
:numbered:
- gnat_ugn/about_this_guide
- gnat_ugn/getting_started_with_gnat
- gnat_ugn/the_gnat_compilation_model
- gnat_ugn/building_executable_programs_with_gnat
- gnat_ugn/gnat_utility_programs
- gnat_ugn/gnat_and_program_execution
+ about_this_guide
+ getting_started_with_gnat
+ the_gnat_compilation_model
+ building_executable_programs_with_gnat
+ gnat_utility_programs
+ gnat_and_program_execution
.. raw:: latex
@@ -54,10 +54,10 @@ GNAT User's Guide for Native Platforms
.. toctree::
:maxdepth: 3
- A. Platform-Specific Information <gnat_ugn/platform_specific_information>
- B. Example of Binder Output <gnat_ugn/example_of_binder_output>
- C. Elaboration Order Handling in GNAT <gnat_ugn/elaboration_order_handling_in_gnat>
- D. Inline Assembler <gnat_ugn/inline_assembler>
- E. GNU Free Documentation License <share/gnu_free_documentation_license>
+ A. Platform-Specific Information <platform_specific_information>
+ B. Example of Binder Output <example_of_binder_output>
+ C. Elaboration Order Handling in GNAT <elaboration_order_handling_in_gnat>
+ D. Inline Assembler <inline_assembler>
+ E. GNU Free Documentation License <gnu_free_documentation_license>
diff --git a/gcc/ada/doc/gnat_ugn/platform_specific_information.rst b/gcc/ada/doc/gnat_ugn/platform_specific_information.rst
index 4d25dea..3ada65d 100644
--- a/gcc/ada/doc/gnat_ugn/platform_specific_information.rst
+++ b/gcc/ada/doc/gnat_ugn/platform_specific_information.rst
@@ -1,11 +1,5 @@
.. role:: switch(samp)
-.. -- Non-breaking space in running text
- -- E.g. Ada |nbsp| 95
-
-.. |nbsp| unicode:: 0xA0
- :trim:
-
.. _Platform_Specific_Information:
*****************************
diff --git a/gcc/ada/doc/share/latex_elements.py b/gcc/ada/doc/share/ada_latex_elements.py
index f23b2af..9578c02 100644
--- a/gcc/ada/doc/share/latex_elements.py
+++ b/gcc/ada/doc/share/ada_latex_elements.py
@@ -1,5 +1,9 @@
# define some latex elements to be used for PDF output
+import os
+
+folder = os.path.dirname(os.path.realpath(__file__))
+
PAGE_BLANK = r'''
\makeatletter
\def\cleartooddpage{%%
@@ -46,7 +50,7 @@ TOC_CMD = r'''
\makeatother
'''
-with open('copyright.tex', 'r') as fd:
+with open(os.path.join(folder, 'copyright.tex'), 'r') as fd:
copyright = fd.read()
TOC = r'''
@@ -62,6 +66,11 @@ LATEX_HYPHEN = r'''
\tolerance=1000
'''
+ENCLOSE = r'''
+@definfoenclose strong,*,*
+@definfoenclose emph,','
+'''
+
def doc_settings(full_document_name, version):
return '\n'.join([
diff --git a/gcc/ada/doc/share/adabaseconf.py b/gcc/ada/doc/share/adabaseconf.py
new file mode 100644
index 0000000..4a80a83
--- /dev/null
+++ b/gcc/ada/doc/share/adabaseconf.py
@@ -0,0 +1,81 @@
+# GNAT build configuration file
+
+import sys
+sys.path.append('.')
+sys.path.append('../../../../doc')
+
+from baseconf import *
+
+import os
+import re
+import sys
+import time
+
+import ada_latex_elements
+
+import ada_pygments
+
+gnatvsn_content = read_file('ada/gnatvsn.ads')
+
+
+def get_gnat_version():
+ m = re.search(r'Gnat_Static_Version_String : ' +
+ r'constant String := "([^\(\)]+)\(.*\)?";',
+ gnatvsn_content)
+ if m:
+ return m.group(1).strip()
+ else:
+ return gcc_BASEVER
+
+
+def get_gnat_build_type():
+ m = re.search(r'Build_Type : constant Gnat_Build_Type := (.+);',
+ gnatvsn_content)
+ if m:
+ return {'Gnatpro': 'PRO',
+ 'FSF': 'FSF',
+ 'GPL': 'GPL'}[m.group(1).strip()]
+ else:
+ print('cannot compute GNAT build type')
+ sys.exit(1)
+
+
+copyright = '2008-%s, Free Software Foundation' % YEAR
+
+version = get_gnat_version()
+release = get_gnat_version()
+
+if os.path.isfile('adacore_transparent.png'):
+ html_logo = 'adacore_transparent.png'
+if os.path.isfile('favicon.ico'):
+ html_favicon = 'favicon.ico'
+
+latex_additional_files = ['../share/gnat.sty']
+
+copyright_macros = {
+ 'date': time.strftime('%b %d, %Y'),
+ 'edition': 'GNAT %s Edition' % 'Pro' if get_gnat_build_type() == 'PRO'
+ else 'GPL',
+ 'name': 'GNU Ada',
+ 'tool': 'GNAT',
+ 'version': version}
+
+
+def set_latex_elements(latex_elements, title):
+ elements = {
+ 'preamble': '\\usepackage{gnat}\n' +
+ ada_latex_elements.TOC_DEPTH +
+ ada_latex_elements.PAGE_BLANK +
+ ada_latex_elements.TOC_CMD +
+ ada_latex_elements.LATEX_HYPHEN +
+ ada_latex_elements.doc_settings(title, get_gnat_version()),
+ 'tableofcontents': ada_latex_elements.TOC % copyright_macros
+ }
+ for key, value in elements.items():
+ latex_elements.setdefault(key, '')
+ latex_elements[key] += value
+
+
+def setup(app):
+ app.add_lexer('ada', ada_pygments.AdaLexer)
+ app.add_lexer('gpr', ada_pygments.GNATProjectLexer)
diff --git a/gcc/ada/doc/share/conf.py b/gcc/ada/doc/share/conf.py
deleted file mode 100644
index bb36bfa..0000000
--- a/gcc/ada/doc/share/conf.py
+++ /dev/null
@@ -1,148 +0,0 @@
-# -*- coding: utf-8 -*-
-# Style_Check:Python_Fragment (meaning no pyflakes check)
-#
-# GNAT build configuration file
-
-import sys
-import os
-import time
-import re
-
-sys.path.append('.')
-
-import ada_pygments
-import latex_elements
-
-# Some configuration values for the various documentation handled by
-# this conf.py
-
-DOCS = {
- 'gnat_rm': {
- 'title': 'GNAT Reference Manual'},
- 'gnat_ugn': {
- 'title': 'GNAT User\'s Guide for Native Platforms'},
- 'gnat-style': {
- 'title': 'GNAT Coding Style: A Guide for GNAT Developers'}}
-
-# Then retrieve the source directory
-root_source_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-gnatvsn_spec = os.path.join(root_source_dir, '..', 'gnatvsn.ads')
-basever = os.path.join(root_source_dir, '..', '..', 'BASE-VER')
-texi_fsf = True # Set to False when FSF doc is switched to sphinx by default
-
-with open(gnatvsn_spec, 'r') as fd:
- gnatvsn_content = fd.read()
-
-
-def get_copyright():
- return '2008-%s, Free Software Foundation' % time.strftime('%Y')
-
-
-def get_gnat_version():
- m = re.search(r'Gnat_Static_Version_String : ' +
- r'constant String := "([^\(\)]+)\(.*\)?";',
- gnatvsn_content)
- if m:
- return m.group(1).strip()
- else:
- if texi_fsf and os.path.exists(basever):
- return ''
-
- try:
- with open(basever) as fd:
- return fd.read()
- except Exception:
- pass
-
- print('cannot find GNAT version in gnatvsn.ads or in ' + basever)
- sys.exit(1)
-
-
-def get_gnat_build_type():
- m = re.search(r'Build_Type : constant Gnat_Build_Type := (.+);',
- gnatvsn_content)
- if m:
- return {'Gnatpro': 'PRO',
- 'FSF': 'FSF',
- 'GPL': 'GPL'}[m.group(1).strip()]
- else:
- print('cannot compute GNAT build type')
- sys.exit(1)
-
-
-# First retrieve the name of the documentation we are building
-doc_name = os.environ.get('DOC_NAME', None)
-if doc_name is None:
- print('DOC_NAME environment variable should be set')
- sys.exit(1)
-
-if doc_name not in DOCS:
- print('%s is not a valid documentation name' % doc_name)
- sys.exit(1)
-
-
-# Exclude sources that are not part of the current documentation
-exclude_patterns = []
-for d in os.listdir(root_source_dir):
- if d not in ('share', doc_name, doc_name + '.rst'):
- exclude_patterns.append(d)
- print('ignoring %s' % d)
-
-if doc_name == 'gnat_rm':
- exclude_patterns.append('share/gnat_project_manager.rst')
- print('ignoring share/gnat_project_manager.rst')
-
-extensions = []
-templates_path = ['_templates']
-source_suffix = '.rst'
-master_doc = doc_name
-
-# General information about the project.
-project = DOCS[doc_name]['title']
-
-copyright = get_copyright()
-
-version = get_gnat_version()
-release = get_gnat_version()
-
-pygments_style = None
-tags.add(get_gnat_build_type())
-html_theme = 'sphinxdoc'
-if os.path.isfile('adacore_transparent.png'):
- html_logo = 'adacore_transparent.png'
-if os.path.isfile('favicon.ico'):
- html_favicon = 'favicon.ico'
-
-html_static_path = ['_static']
-
-latex_additional_files = ['gnat.sty']
-
-copyright_macros = {
- 'date': time.strftime("%b %d, %Y"),
- 'edition': 'GNAT %s Edition' % 'Pro' if get_gnat_build_type() == 'PRO'
- else 'GPL',
- 'name': 'GNU Ada',
- 'tool': 'GNAT',
- 'version': version}
-
-latex_elements = {
- 'preamble': '\\usepackage{gnat}\n' +
- latex_elements.TOC_DEPTH +
- latex_elements.PAGE_BLANK +
- latex_elements.TOC_CMD +
- latex_elements.LATEX_HYPHEN +
- latex_elements.doc_settings(DOCS[doc_name]['title'],
- get_gnat_version()),
- 'tableofcontents': latex_elements.TOC % copyright_macros}
-
-latex_documents = [
- (master_doc, '%s.tex' % doc_name, project, 'AdaCore', 'manual')]
-
-texinfo_documents = [
- (master_doc, doc_name, project,
- 'AdaCore', doc_name, doc_name, '')]
-
-
-def setup(app):
- app.add_lexer('ada', ada_pygments.AdaLexer)
- app.add_lexer('gpr', ada_pygments.GNATProjectLexer)
diff --git a/gcc/ada/doc/share/gnu_free_documentation_license.rst b/gcc/ada/doc/share/gnu_free_documentation_license.rst
deleted file mode 100644
index 0235545..0000000
--- a/gcc/ada/doc/share/gnu_free_documentation_license.rst
+++ /dev/null
@@ -1,458 +0,0 @@
-.. _gnu_fdl:
-
-******************************
-GNU Free Documentation License
-******************************
-
-Version 1.3, 3 November 2008
-
-Copyright 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc
-https://fsf.org/
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
-**Preamble**
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-**1. APPLICABILITY AND DEFINITIONS**
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The **Document**, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as "**you**". You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A "**Modified Version**" of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A "**Secondary Section**" is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The "**Invariant Sections**" are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The "**Cover Texts**" are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A "**Transparent**" copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called **Opaque**.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The "**Title Page**" means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-The "**publisher**" means any person or entity that distributes
-copies of the Document to the public.
-
-A section "**Entitled XYZ**" means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as "**Acknowledgements**",
-"**Dedications**", "**Endorsements**", or "**History**".)
-To "**Preserve the Title**"
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-**2. VERBATIM COPYING**
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-**3. COPYING IN QUANTITY**
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-**4. MODIFICATIONS**
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-A. Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-B. List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-C. State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-D. Preserve all the copyright notices of the Document.
-
-E. Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-F. Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-G. Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-H. Include an unaltered copy of this License.
-
-I. Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-J. Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-K. For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-L. Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-M. Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-N. Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-O. Preserve any Warranty Disclaimers.
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties---for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-**5. COMBINING DOCUMENTS**
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-**6. COLLECTIONS OF DOCUMENTS**
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-**7. AGGREGATION WITH INDEPENDENT WORKS**
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-**8. TRANSLATION**
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-**9. TERMINATION**
-
-You may not copy, modify, sublicense, or distribute the Document
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense, or distribute it is void, and
-will automatically terminate your rights under this License.
-
-However, if you cease all violation of this License, then your license
-from a particular copyright holder is reinstated (a) provisionally,
-unless and until the copyright holder explicitly and finally
-terminates your license, and (b) permanently, if the copyright holder
-fails to notify you of the violation by some reasonable means prior to
-60 days after the cessation.
-
-Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, receipt of a copy of some or all of the same material does
-not give you any rights to use it.
-
-**10. FUTURE REVISIONS OF THIS LICENSE**
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-https://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation. If the Document
-specifies that a proxy can decide which future versions of this
-License can be used, that proxy's public statement of acceptance of a
-version permanently authorizes you to choose that version for the
-Document.
-
-**11. RELICENSING**
-
-"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
-World Wide Web server that publishes copyrightable works and also
-provides prominent facilities for anybody to edit those works. A
-public wiki that anybody can edit is an example of such a server. A
-"Massive Multiauthor Collaboration" (or "MMC") contained in the
-site means any set of copyrightable works thus published on the MMC
-site.
-
-"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
-license published by Creative Commons Corporation, a not-for-profit
-corporation with a principal place of business in San Francisco,
-California, as well as future copyleft versions of that license
-published by that same organization.
-
-"Incorporate" means to publish or republish a Document, in whole or
-in part, as part of another Document.
-
-An MMC is "eligible for relicensing" if it is licensed under this
-License, and if all works that were first published under this License
-somewhere other than this MMC, and subsequently incorporated in whole
-or in part into the MMC, (1) had no cover texts or invariant sections,
-and (2) were thus incorporated prior to November 1, 2008.
-
-The operator of an MMC Site may republish an MMC contained in the site
-under CC-BY-SA on the same site at any time before August 1, 2009,
-provided the MMC is eligible for relicensing.
-
-**ADDENDUM: How to use this License for your documents**
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
- Copyright © YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.3
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with ... Texts." line with this:
-
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.