Commit c25f170d by Arnaud Charlet Committed by Arnaud Charlet

gnat_rm.texi, [...]: Update doc.

        * gnat_rm.texi, gnat_ugn.texi,
        doc/gnat_ugn/gnat_project_manager.rst,
        doc/gnat_ugn/building_executable_programs_with_gnat.rst,
        doc/gnat_ugn/gnat_and_program_execution.rst,
        doc/gnat_ugn/gnat_utility_programs.rst,
        doc/gnat_ugn/the_gnat_compilation_model.rst,
        doc/gnat_rm/implementation_defined_attributes.rst,
        doc/gnat_rm/standard_and_implementation_defined_restrictions.rst,
        doc/gnat_rm/implementation_defined_pragmas.rst,
        doc/gnat_rm/the_gnat_library.rst,
        doc/gnat_rm/implementation_defined_aspects.rst: Update doc.
        * doc/Makefile: Cleanups.

From-SVN: r235328
parent f76647c2
2016-04-21 Arnaud Charlet <charlet@adacore.com>
* gnat_rm.texi, gnat_ugn.texi,
doc/gnat_ugn/gnat_project_manager.rst,
doc/gnat_ugn/building_executable_programs_with_gnat.rst,
doc/gnat_ugn/gnat_and_program_execution.rst,
doc/gnat_ugn/gnat_utility_programs.rst,
doc/gnat_ugn/the_gnat_compilation_model.rst,
doc/gnat_rm/implementation_defined_attributes.rst,
doc/gnat_rm/standard_and_implementation_defined_restrictions.rst,
doc/gnat_rm/implementation_defined_pragmas.rst,
doc/gnat_rm/the_gnat_library.rst,
doc/gnat_rm/implementation_defined_aspects.rst: Update doc.
* doc/Makefile: Cleanups.
2016-04-21 Hristian Kirtchev <kirtchev@adacore.com>
* exp_pakd.adb, sem_ch13.adb: Minor reformatting.
......
......@@ -24,26 +24,23 @@ help:
@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.texinfo to make Texinfo 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 " texinfo-all same as previous rule but only for texinfo 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 overriden using SOURCEDIR and BUILDDIR variables"
@echo "source and location can be overridden using SOURCEDIR and BUILDDIR variables"
clean:
-rm -rf $(BUILDDIR)/*/html \
$(BUILDDIR)/*/pdf \
$(BUILDDIR)/*/txt \
$(BUILDDIR)/*/info
-rm -rf $(BUILDDIR)
%.html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/$*/html
......@@ -65,16 +62,23 @@ clean:
$(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))
all: $(foreach fmt, $(FMT_LIST), $(fmt).all)
.PHONY: all
all: $(foreach fmt, $(FMT_LIST), $(fmt)-all)
......@@ -670,6 +670,8 @@ passed for a record or other composite object passed by reference.
There is no way of indicating this without the `Null_Parameter`
attribute.
.. _Attribute-Object_Size:
Attribute Object_Size
=====================
.. index:: Size, used for objects
......@@ -901,6 +903,8 @@ The `Safe_Small` attribute is provided for compatibility with Ada 83. See
the Ada 83 reference manual for an exact description of the semantics of
this attribute.
.. _Attribute-Scalar_Storage_Order:
Attribute Scalar_Storage_Order
==============================
.. index:: Endianness
......@@ -1556,6 +1560,8 @@ typical machines). In addition `'VADS_Size` applied to an object
gives the result that would be obtained by applying the attribute to
the corresponding type.
.. _Attribute-Value_Size:
Attribute Value_Size
====================
.. index:: Size, setting for not-first subtype
......
......@@ -525,7 +525,7 @@ No_Multiple_Elaboration
.. index:: No_Multiple_Elaboration
[GNAT] When this restriction is active, we are not requesting control-flow
preservation with -fpreserve-control-flow and the static elaboration model is
preservation with -fpreserve-control-flow, and the static elaboration model is
used, the compiler is allowed to suppress the elaboration counter normally
associated with the unit, even if the unit has elaboration code. This counter
is typically used to check for access before elaboration and to control
......@@ -877,10 +877,10 @@ code generation. If it is used in conjunction with "semantics only"
checking, then some cases of violations may be missed.
When this restriction is active, we are not requesting control-flow
preservation with -fpreserve-control-flow and the static elaboration model is
preservation with -fpreserve-control-flow, and the static elaboration model is
used, the compiler is allowed to suppress the elaboration counter normally
associated with the unit, used to check for access before elaboration and to
control.
associated with the unit. This counter is typically used to check for access
before elaboration and to control multiple elaboration attempts.
No_Dynamic_Sized_Objects
------------------------
......
......@@ -1735,6 +1735,18 @@ introduction to the binding contents and use.
SSE vector types for use with SSE related intrinsics.
.. _`GNAT.String_Hash(g-strhas.ads)`:
`GNAT.String_Hash` (:file:`g-strhas.ads`)
=========================================
.. index:: GNAT.String_Hash (g-strhas.ads)
.. index:: Hash functions
Provides a generic hash function working on arrays of scalars. Both the scalar
type and the hash result type are parameters.
.. _`GNAT.Strings_(g-string.ads)`:
`GNAT.Strings` (:file:`g-string.ads`)
......@@ -2228,4 +2240,3 @@ This package provides definitions and descriptions of
the various methods used for encoding wide characters
in ordinary strings. These definitions are used by
the package `System.Wch_Cnv`.
......@@ -3055,11 +3055,10 @@ of the pragma in the :title:`GNAT_Reference_manual`).
.. index:: Hiding of Declarations
This switch activates warnings on hiding declarations.
A declaration is considered hiding
if it is for a non-overloadable entity, and it declares an entity with the
same name as some other entity that is directly or use-visible. The default
is that such warnings are not generated.
This switch activates warnings on hiding declarations that are considered
potentially confusing. Not all cases of hiding cause warnings; for example an
overriding declaration hides an implicit declaration, which is just normal
code. The default is that warnings on hiding are not generated.
.. index:: -gnatwH (gcc)
......
......@@ -2790,8 +2790,6 @@ appropriate options.
indicate that the analysed set of sources is incomplete to make up a
partition and that some subprogram bodies are missing are not generated.
Note: to invoke *gnatelim* with a project file, use the `gnat`
driver (see :ref:`The_GNAT_Driver_and_Project_Files`).
.. _Processing_Precompiled_Libraries:
......
......@@ -4156,9 +4156,9 @@ Package Builder Attributes
* **Global_Compilation_Switches**: list, optional index, indexed,
case-insensitive index
Index is either a language name or a source file name. Value is the list of
compilation switches to be used when building an executable. Index is either
the source file name of the executable to be built or its language name.
Index is a language name. Value is the list of compilation switches to be
used when building an executable. Index is either the source file name of
the executable to be built or its language name.
* **Executable**: single, indexed, case-insensitive index
......
......@@ -4962,6 +4962,7 @@ Alternatively, you may run the script using the following command line:
not supported;
* tests for protected subprograms and entries are not supported;
* pragma *No_Run_Time* is not supported;
* pragma *No_Secondary_Stack* is not supported;
* if pragmas for interfacing with foreign languages are used, manual
adjustments might be necessary to make the test harness compilable;
* use of elaboration control pragmas may result in elaboration circularities
......
......@@ -2865,6 +2865,17 @@ where
Switches for `gnatprep`
^^^^^^^^^^^^^^^^^^^^^^^
.. index:: --version (gnatprep)
:samp:`--version`
Display Copyright and version, then exit disregarding all other options.
.. index:: --help (gnatprep)
:samp:`--help`
If *--version* was not used, display usage, then exit disregarding
all other options.
.. index:: -b (gnatprep)
:samp:`-b`
......@@ -2922,6 +2933,12 @@ Switches for `gnatprep`
Causes a sorted list of symbol names and values to be
listed on the standard output file.
.. index:: -T (gnatprep)
:samp:`-T`
Use LF as line terminators when writing files. By default the line terminator
of the host (LF under unix, CR/LF under Windows) is used.
.. index:: -u (gnatprep)
:samp:`-u`
......@@ -2929,6 +2946,11 @@ Switches for `gnatprep`
of a preprocessor test. In the absence of this option, an undefined symbol in
a `#if` or `#elsif` test will be treated as an error.
.. index:: -v (gnatprep)
:samp:`-v`
Verbose mode: generates more output about work done.
Note: if neither *-b* nor *-c* is present,
then preprocessor lines and
......@@ -3126,10 +3148,18 @@ preprocessing is triggered and parameterized.
:samp:`-gnatep={file}`
This switch indicates to the compiler the file name (without directory
information) of the preprocessor data file to use. The preprocessor data file
should be found in the source directories. Note that when the compiler is
called by a builder such as (*gnatmake* with a project
file, if the object directory is not also a source directory, the builder needs
to be called with *-x*.
should be found in the source directories. Alternatively when using project
files, you can reference to the project file's directory via the
``project name'Project_Dir`` project attribute, e.g:
.. code-block:: gpr
project Prj is
package Compiler is
for Switches ("Ada") use
("-gnatep=" & Prj'Project_Dir & "prep.def");
end Compiler;
end Prj;
A preprocessing data file is a text file with significant lines indicating
how should be preprocessed either a specific source or all sources not
......
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -21,7 +21,7 @@
@copying
@quotation
GNAT User's Guide for Native Platforms , November 18, 2015
GNAT User's Guide for Native Platforms , April 21, 2016
AdaCore
......@@ -4828,6 +4828,27 @@ optional, and can be replaced by the use of the @emph{-D} switch.
@subsubsection Switches for @cite{gnatprep}
@geindex --version (gnatprep)
@table @asis
@item @code{--version}
Display Copyright and version, then exit disregarding all other options.
@end table
@geindex --help (gnatprep)
@table @asis
@item @code{--help}
If @emph{--version} was not used, display usage, then exit disregarding
all other options.
@end table
@geindex -b (gnatprep)
......@@ -4915,6 +4936,17 @@ Causes a sorted list of symbol names and values to be
listed on the standard output file.
@end table
@geindex -T (gnatprep)
@table @asis
@item @code{-T}
Use LF as line terminators when writing files. By default the line terminator
of the host (LF under unix, CR/LF under Windows) is used.
@end table
@geindex -u (gnatprep)
......@@ -4927,6 +4959,16 @@ of a preprocessor test. In the absence of this option, an undefined symbol in
a @cite{#if} or @cite{#elsif} test will be treated as an error.
@end table
@geindex -v (gnatprep)
@table @asis
@item @code{-v}
Verbose mode: generates more output about work done.
@end table
Note: if neither @emph{-b} nor @emph{-c} is present,
then preprocessor lines and
deleted lines are completely removed from the output, unless -r is
......@@ -5138,10 +5180,18 @@ preprocessing is triggered and parameterized.
This switch indicates to the compiler the file name (without directory
information) of the preprocessor data file to use. The preprocessor data file
should be found in the source directories. Note that when the compiler is
called by a builder such as (@emph{gnatmake} with a project
file, if the object directory is not also a source directory, the builder needs
to be called with @emph{-x}.
should be found in the source directories. Alternatively when using project
files, you can reference to the project file's directory via the
@code{project name'Project_Dir} project attribute, e.g:
@example
project Prj is
package Compiler is
for Switches ("Ada") use
("-gnatep=" & Prj'Project_Dir & "prep.def");
end Compiler;
end Prj;
@end example
A preprocessing data file is a text file with significant lines indicating
how should be preprocessed either a specific source or all sources not
......@@ -11287,11 +11337,10 @@ but more warnings may be added in the future without advanced notice.
@geindex Hiding of Declarations
This switch activates warnings on hiding declarations.
A declaration is considered hiding
if it is for a non-overloadable entity, and it declares an entity with the
same name as some other entity that is directly or use-visible. The default
is that such warnings are not generated.
This switch activates warnings on hiding declarations that are considered
potentially confusing. Not all cases of hiding cause warnings; for example an
overriding declaration hides an implicit declaration, which is just normal
code. The default is that warnings on hiding are not generated.
@end table
@geindex -gnatwH (gcc)
......@@ -21645,9 +21694,9 @@ source file name of the executable to be built or its language name.
@strong{Global_Compilation_Switches}: list, optional index, indexed,
case-insensitive index
Index is either a language name or a source file name. Value is the list of
compilation switches to be used when building an executable. Index is either
the source file name of the executable to be built or its language name.
Index is a language name. Value is the list of compilation switches to be
used when building an executable. Index is either the source file name of
the executable to be built or its language name.
@item
@strong{Executable}: single, indexed, case-insensitive index
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment