install.texi: Update and clarify requirements to build GNAT.
authorArnaud Charlet <charlet@adacore.com>
Thu, 5 Sep 2019 09:51:38 +0000 (09:51 +0000)
committerArnaud Charlet <charlet@gcc.gnu.org>
Thu, 5 Sep 2019 09:51:38 +0000 (11:51 +0200)
* doc/install.texi: Update and clarify requirements to build GNAT.

From-SVN: r275400

gcc/ChangeLog
gcc/doc/install.texi

index ee8c2441bb73212625a2332b8395ae7965369521..cf11319265483b20811db794f10998df7a1fcec0 100644 (file)
@@ -1,3 +1,7 @@
+2019-09-05  Arnaud Charlet  <charlet@adacore.com>
+
+       * doc/install.texi: Update and clarify requirements to build GNAT.
+
 2019-09-05  Richard Sandiford  <richard.sandiford@arm.com>
 
        PR middle-end/91577
index d3a2242c9e7ac157ad0077d607201c1bf9086341..6f4dd7b98556c0afc36d054ee16c7da9ec1b6c6e 100644 (file)
@@ -270,12 +270,34 @@ name of the package depends on your distro) or you must build GCC as a
 @option{--disable-multilib}.  Otherwise, you may encounter an error such as
 @samp{fatal error: gnu/stubs-32.h: No such file}
 
-@item GNAT
+@item @anchor{GNAT-prerequisite}GNAT
 
-In order to build the Ada compiler (GNAT) you must already have GNAT
-installed because portions of the Ada frontend are written in Ada (with
-GNAT extensions.)  Refer to the Ada installation instructions for more
-specific information.
+In order to build GNAT, the Ada compiler, you need a working GNAT
+compiler (GCC version 4.7 or later).
+
+This includes GNAT tools such as @command{gnatmake} and
+@command{gnatlink}, since the Ada front end is written in Ada and
+uses some GNAT-specific extensions.
+
+In order to build a cross compiler, it is strongly recommended to install
+the new compiler as native first, and then use it to build the cross
+compiler. Other native compiler versions may work but this is not guaranteed and
+will typically fail with hard to understand compilation errors during the
+build.
+
+Similarly, it is strongly recommended to use an older version of GNAT to build
+GNAT. More recent versions of GNAT than the version built are not guaranteed
+to work and will often fail during the build with compilation errors.
+
+Note that @command{configure} does not test whether the GNAT installation works
+and has a sufficiently recent version; if too old a GNAT version is
+installed and @option{--enable-languages=ada} is used, the build will fail.
+
+@env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
+must not be set when building the Ada compiler, the Ada tools, or the
+Ada runtime libraries. You can check that your build environment is clean
+by verifying that @samp{gnatls -v} lists only one explicit path in each
+section.
 
 @item A ``working'' POSIX compatible shell, or GNU bash
 
@@ -2705,26 +2727,7 @@ and network filesystems.
 
 @section Building the Ada compiler
 
-In order to build GNAT, the Ada compiler, you need a working GNAT
-compiler (GCC version 4.0 or later).
-This includes GNAT tools such as @command{gnatmake} and
-@command{gnatlink}, since the Ada front end is written in Ada and
-uses some GNAT-specific extensions.
-
-In order to build a cross compiler, it is suggested to install
-the new compiler as native first, and then use it to build the cross
-compiler.
-
-@command{configure} does not test whether the GNAT installation works
-and has a sufficiently recent version; if too old a GNAT version is
-installed, the build will fail unless @option{--enable-languages} is
-used to disable building the Ada front end.
-
-@env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
-must not be set when building the Ada compiler, the Ada tools, or the
-Ada runtime libraries. You can check that your build environment is clean
-by verifying that @samp{gnatls -v} lists only one explicit path in each
-section.
+See @ref{GNAT-prerequisite}.
 
 @section Building with profile feedback