[PATCH][DOCS] Remove install-old.texi

[PATCH][DOCS] Remove install-old.texi

[Martin Liška]

Hello.

As mentioned at the beginning of https://gcc.gnu.org/install/old.html:
"Note most of this information is out of date and superseded by the previous chapters of this manual."

The installation page is deprecated for 20 years now.

Does it make sense to remove it?
Thanks,
Martin

gcc/ChangeLog:

	* Makefile.in: Remove it.
	* doc/include/fdl.texi: Update next/previous chapters.
	* doc/install.texi: Likewise.
	* doc/install-old.texi: Removed.
---
  gcc/Makefile.in          |   2 +-
  gcc/doc/include/fdl.texi |   2 +-
  gcc/doc/install-old.texi | 184 ---------------------------------------
  gcc/doc/install.texi     |  20 +----
  4 files changed, 3 insertions(+), 205 deletions(-)
  delete mode 100644 gcc/doc/install-old.texi

diff --git a/gcc/Makefile.in b/gcc/Makefile.in
index 1b5d3f4696c..5fd6ac97117 100644
--- a/gcc/Makefile.in
+++ b/gcc/Makefile.in
@@ -3314,7 +3314,7 @@ TEXI_GCCINT_FILES = gccint.texi gcc-common.texi gcc-vers.texi		\
  	 loop.texi generic.texi gimple.texi plugins.texi optinfo.texi   \
  	 match-and-simplify.texi analyzer.texi ux.texi poly-int.texi
  
-TEXI_GCCINSTALL_FILES = install.texi install-old.texi fdl.texi		\
+TEXI_GCCINSTALL_FILES = install.texi fdl.texi		\
  	 gcc-common.texi gcc-vers.texi
  
  TEXI_CPPINT_FILES = cppinternals.texi gcc-common.texi gcc-vers.texi
diff --git a/gcc/doc/include/fdl.texi b/gcc/doc/include/fdl.texi
index 4e3457fe9c4..7fa222c5f32 100644
--- a/gcc/doc/include/fdl.texi
+++ b/gcc/doc/include/fdl.texi
@@ -19,7 +19,7 @@ of this license document, but changing it is not allowed.
  @ifset gfdlhtml
  @ifnothtml
  @comment node-name,     next,          previous, up
-@node    GNU Free Documentation License, Concept Index, Old, Top
+@node    GNU Free Documentation License, Concept Index, Specific, Top
  @end ifnothtml
  @html
  <h1 align="center">Installing GCC: GNU Free Documentation License</h1>
diff --git a/gcc/doc/install-old.texi b/gcc/doc/install-old.texi
deleted file mode 100644
index b425971f944..00000000000
--- a/gcc/doc/install-old.texi
+++ /dev/null
@@ -1,184 +0,0 @@
-@c Copyright (C) 1988-2021 Free Software Foundation, Inc.
-@c This is part of the GCC manual.
-@c For copying conditions, see the file install.texi.
-
-@ifnothtml
-@comment node-name,     next,          previous, up
-@node    Old, GNU Free Documentation License, Specific, Top
-@end ifnothtml
-@html
-<h1 align="center">Old installation documentation</h1>
-@end html
-@ifnothtml
-@chapter Old installation documentation
-@end ifnothtml
-
-Note most of this information is out of date and superseded by the
-previous chapters of this manual.  It is provided for historical
-reference only, because of a lack of volunteers to merge it into the
-main manual.
-
-@ifnothtml
-@menu
-* Configurations::    Configurations Supported by GCC.
-@end menu
-@end ifnothtml
-
-Here is the procedure for installing GCC on a GNU or Unix system.
-
-@enumerate
-@item
-If you have chosen a configuration for GCC which requires other GNU
-tools (such as GAS or the GNU linker) instead of the standard system
-tools, install the required tools in the build directory under the names
-@file{as}, @file{ld} or whatever is appropriate.
-
-Alternatively, you can do subsequent compilation using a value of the
-@code{PATH} environment variable such that the necessary GNU tools come
-before the standard system tools.
-
-@item
-Specify the host, build and target machine configurations.  You do this
-when you run the @file{configure} script.
-
-The @dfn{build} machine is the system which you are using, the
-@dfn{host} machine is the system where you want to run the resulting
-compiler (normally the build machine), and the @dfn{target} machine is
-the system for which you want the compiler to generate code.
-
-If you are building a compiler to produce code for the machine it runs
-on (a native compiler), you normally do not need to specify any operands
-to @file{configure}; it will try to guess the type of machine you are on
-and use that as the build, host and target machines.  So you don't need
-to specify a configuration when building a native compiler unless
-@file{configure} cannot figure out what your configuration is or guesses
-wrong.
-
-In those cases, specify the build machine's @dfn{configuration name}
-with the @option{--host} option; the host and target will default to be
-the same as the host machine.
-
-Here is an example:
-
-@smallexample
-./configure --host=sparc-sun-sunos4.1
-@end smallexample
-
-A configuration name may be canonical or it may be more or less
-abbreviated.
-
-A canonical configuration name has three parts, separated by dashes.
-It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.
-(The three parts may themselves contain dashes; @file{configure}
-can figure out which dashes serve which purpose.)  For example,
-@samp{m68k-sun-sunos4.1} specifies a Sun 3.
-
-You can also replace parts of the configuration by nicknames or aliases.
-For example, @samp{sun3} stands for @samp{m68k-sun}, so
-@samp{sun3-sunos4.1} is another way to specify a Sun 3.
-
-You can specify a version number after any of the system types, and some
-of the CPU types.  In most cases, the version is irrelevant, and will be
-ignored.  So you might as well specify the version if you know it.
-
-See @ref{Configurations}, for a list of supported configuration names and
-notes on many of the configurations.  You should check the notes in that
-section before proceeding any further with the installation of GCC@.
-
-@end enumerate
-
-@ifnothtml
-@node Configurations, , , Old
-@section Configurations Supported by GCC
-@end ifnothtml
-@html
-<h2>@anchor{Configurations}Configurations Supported by GCC</h2>
-@end html
-@cindex configurations supported by GCC
-
-Here are the possible CPU types:
-
-@quotation
-@c gmicro, fx80, spur and tahoe omitted since they don't work.
-1750a, a29k, alpha, arm, avr, c@var{n}, clipper, dsp16xx, elxsi, fr30, h8300,
-hppa1.0, hppa1.1, i370, i386, i486, i586, i686, i786, i860, i960, ip2k, m32r,
-m68000, m68k, m88k, mcore, mips, mipsel, mips64, mips64el,
-mn10200, mn10300, ns32k, pdp11, powerpc, powerpcle, romp, rs6000, sh, sparc,
-sparclite, sparc64, v850, vax, we32k.
-@end quotation
-
-Here are the recognized company names.  As you can see, customary
-abbreviations are used rather than the longer official names.
-
-@c What should be done about merlin, tek*, dolphin?
-@quotation
-acorn, alliant, altos, apollo, apple, att, bull,
-cbm, convergent, convex, crds, dec, dg, dolphin,
-elxsi, encore, harris, hitachi, hp, ibm, intergraph, isi,
-mips, motorola, ncr, next, ns, omron, plexus,
-sequent, sgi, sony, sun, tti, unicom, wrs.
-@end quotation
-
-The company name is meaningful only to disambiguate when the rest of
-the information supplied is insufficient.  You can omit it, writing
-just @samp{@var{cpu}-@var{system}}, if it is not needed.  For example,
-@samp{vax-ultrix4.2} is equivalent to @samp{vax-dec-ultrix4.2}.
-
-Here is a list of system types:
-
-@quotation
-386bsd, aix, acis, amigaos, aos, aout, aux, bosx, bsd, clix, coff, ctix, cxux,
-dgux, dynix, ebmon, ecoff, elf, esix, freebsd, hms, genix, gnu, linux,
-linux-gnu, hiux, hpux, iris, irix, isc, luna, lynxos, mach, minix, msdos, mvs,
-netbsd, newsos, nindy, ns, osf, osfrose, ptx, riscix, riscos, rtu, sco, sim,
-solaris, sunos, sym, sysv, udi, ultrix, unicos, uniplus, unos, vms, vsta,
-vxworks, winnt, xenix.
-@end quotation
-
-@noindent
-You can omit the system type; then @file{configure} guesses the
-operating system from the CPU and company.
-
-You can add a version number to the system type; this may or may not
-make a difference.  For example, you can write @samp{bsd4.3} or
-@samp{bsd4.4} to distinguish versions of BSD@.  In practice, the version
-number is most needed for @samp{sysv3} and @samp{sysv4}, which are often
-treated differently.
-
-@samp{linux-gnu} is the canonical name for the GNU/Linux target; however
-GCC will also accept @samp{linux}.  The version of the kernel in use is
-not relevant on these systems.  A suffix such as @samp{libc1} or @samp{aout}
-distinguishes major versions of the C library; all of the suffixed versions
-are obsolete.
-
-If you specify an impossible combination such as @samp{i860-dg-vms},
-then you may get an error message from @file{configure}, or it may
-ignore part of the information and do the best it can with the rest.
-@file{configure} always prints the canonical name for the alternative
-that it used.  GCC does not support all possible alternatives.
-
-Often a particular model of machine has a name.  Many machine names are
-recognized as aliases for CPU/company combinations.  Thus, the machine
-name @samp{sun3}, mentioned above, is an alias for @samp{m68k-sun}.
-Sometimes we accept a company name as a machine name, when the name is
-popularly used for a particular machine.  Here is a table of the known
-machine names:
-
-@quotation
-3300, 3b1, 3b@var{n}, 7300, altos3068, altos,
-apollo68, att-7300, balance,
-convex-c@var{n}, crds, decstation-3100,
-decstation, delta, encore,
-fx2800, gmicro, hp7@var{nn}, hp8@var{nn},
-hp9k2@var{nn}, hp9k3@var{nn}, hp9k7@var{nn},
-hp9k8@var{nn}, iris4d, iris, isi68,
-m3230, magnum, merlin, miniframe,
-mmax, news-3600, news800, news, next,
-pbd, pc532, pmax, powerpc, powerpcle, ps2, risc-news,
-rtpc, sun2, sun386i, sun386, sun3,
-sun4, symmetry, tower-32, tower.
-@end quotation
-
-@noindent
-Remember that a machine name specifies both the cpu type and the company
-name.
diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index 261951848d4..f0591e06b3e 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -36,9 +36,6 @@
  @ifset binarieshtml
  @settitle Installing GCC: Binaries
  @end ifset
-@ifset oldhtml
-@settitle Installing GCC: Old documentation
-@end ifset
  @ifset gfdlhtml
  @settitle Installing GCC: GNU Free Documentation License
  @end ifset
@@ -62,7 +59,6 @@
  @set testhtml
  @set finalinstallhtml
  @set binarieshtml
-@set oldhtml
  @set gfdlhtml
  @end ifnothtml
  
@@ -120,8 +116,6 @@ Free Documentation License}''.
  * Specific::        Host/target specific installation notes for GCC.
  * Binaries::        Where to get pre-compiled binaries.
  
-* Old::             Old installation documentation.
-
  * GNU Free Documentation License:: How you can copy and share this manual.
  * Concept Index::   This index has two entries.
  @end menu
@@ -3446,7 +3440,7 @@ links to GNU Fortran binaries for several platforms.
  @c ***Specific****************************************************************
  @ifnothtml
  @comment node-name,     next,          previous, up
-@node    Specific, Old, Binaries, Top
+@node    Specific, GNU Free Documentation License, Binaries, Top
  @end ifnothtml
  @ifset specifichtml
  @ifnothtml
@@ -5140,18 +5134,6 @@ automatically.
  @end ifhtml
  @end ifset
  
-@c ***Old documentation******************************************************
-@ifset oldhtml
-@include install-old.texi
-@html
-<hr />
-<p>
-@end html
-@ifhtml
-@uref{./index.html,,Return to the GCC Installation page}
-@end ifhtml
-@end ifset
-
  @c ***GFDL********************************************************************
  @ifset gfdlhtml
  @include fdl.texi
-- 
2.31.1

Re: [PATCH][DOCS] Remove install-old.texi

[Richard Sandiford]

Martin Liška <mliska@suse.cz> writes:
> Hello.
>
> As mentioned at the beginning of https://gcc.gnu.org/install/old.html:
> "Note most of this information is out of date and superseded by the previous chapters of this manual."
>
> The installation page is deprecated for 20 years now.
>
> Does it make sense to remove it?
> Thanks,
> Martin

I agree this makes sense, but it looks like there's some stuff here that
isn't explained (or isn't explained as well) in the new version.  E.g.:

> -Here is the procedure for installing GCC on a GNU or Unix system.
> -
> -@enumerate
> -@item
> -If you have chosen a configuration for GCC which requires other GNU
> -tools (such as GAS or the GNU linker) instead of the standard system
> -tools, install the required tools in the build directory under the names
> -@file{as}, @file{ld} or whatever is appropriate.
> -
> -Alternatively, you can do subsequent compilation using a value of the
> -@code{PATH} environment variable such that the necessary GNU tools come
> -before the standard system tools.
> -
> -@item
> -Specify the host, build and target machine configurations.  You do this
> -when you run the @file{configure} script.
> -
> -The @dfn{build} machine is the system which you are using, the
> -@dfn{host} machine is the system where you want to run the resulting
> -compiler (normally the build machine), and the @dfn{target} machine is
> -the system for which you want the compiler to generate code.

I can't see the equivalent of this paragraph in the new docs.
There are scattered examples that use --build and --host, but nothing
that says what --build and --host actually do.

> -If you are building a compiler to produce code for the machine it runs
> -on (a native compiler), you normally do not need to specify any operands
> -to @file{configure}; it will try to guess the type of machine you are on
> -and use that as the build, host and target machines.  So you don't need
> -to specify a configuration when building a native compiler unless
> -@file{configure} cannot figure out what your configuration is or guesses
> -wrong.
> -
> -In those cases, specify the build machine's @dfn{configuration name}
> -with the @option{--host} option; the host and target will default to be
> -the same as the host machine.
> -
> -Here is an example:
> -
> -@smallexample
> -./configure --host=sparc-sun-sunos4.1
> -@end smallexample
> -
> -A configuration name may be canonical or it may be more or less
> -abbreviated.
> -
> -A canonical configuration name has three parts, separated by dashes.
> -It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.

This too isn't said explicitly in the new docs AFAICS.

Thanks for cleaning this up.

Richard

> -(The three parts may themselves contain dashes; @file{configure}
> -can figure out which dashes serve which purpose.)  For example,
> -@samp{m68k-sun-sunos4.1} specifies a Sun 3.
> -
> -You can also replace parts of the configuration by nicknames or aliases.
> -For example, @samp{sun3} stands for @samp{m68k-sun}, so
> -@samp{sun3-sunos4.1} is another way to specify a Sun 3.
> -
> -You can specify a version number after any of the system types, and some
> -of the CPU types.  In most cases, the version is irrelevant, and will be
> -ignored.  So you might as well specify the version if you know it.
> -
> -See @ref{Configurations}, for a list of supported configuration names and
> -notes on many of the configurations.  You should check the notes in that
> -section before proceeding any further with the installation of GCC@.
> -
> -@end enumerate
> -
> -@ifnothtml
> -@node Configurations, , , Old
> -@section Configurations Supported by GCC
> -@end ifnothtml
> -@html
> -<h2>@anchor{Configurations}Configurations Supported by GCC</h2>
> -@end html
> -@cindex configurations supported by GCC
> -
> -Here are the possible CPU types:
> -
> -@quotation
> -@c gmicro, fx80, spur and tahoe omitted since they don't work.
> -1750a, a29k, alpha, arm, avr, c@var{n}, clipper, dsp16xx, elxsi, fr30, h8300,
> -hppa1.0, hppa1.1, i370, i386, i486, i586, i686, i786, i860, i960, ip2k, m32r,
> -m68000, m68k, m88k, mcore, mips, mipsel, mips64, mips64el,
> -mn10200, mn10300, ns32k, pdp11, powerpc, powerpcle, romp, rs6000, sh, sparc,
> -sparclite, sparc64, v850, vax, we32k.
> -@end quotation
> -
> -Here are the recognized company names.  As you can see, customary
> -abbreviations are used rather than the longer official names.
> -
> -@c What should be done about merlin, tek*, dolphin?
> -@quotation
> -acorn, alliant, altos, apollo, apple, att, bull,
> -cbm, convergent, convex, crds, dec, dg, dolphin,
> -elxsi, encore, harris, hitachi, hp, ibm, intergraph, isi,
> -mips, motorola, ncr, next, ns, omron, plexus,
> -sequent, sgi, sony, sun, tti, unicom, wrs.
> -@end quotation
> -
> -The company name is meaningful only to disambiguate when the rest of
> -the information supplied is insufficient.  You can omit it, writing
> -just @samp{@var{cpu}-@var{system}}, if it is not needed.  For example,
> -@samp{vax-ultrix4.2} is equivalent to @samp{vax-dec-ultrix4.2}.
> -
> -Here is a list of system types:
> -
> -@quotation
> -386bsd, aix, acis, amigaos, aos, aout, aux, bosx, bsd, clix, coff, ctix, cxux,
> -dgux, dynix, ebmon, ecoff, elf, esix, freebsd, hms, genix, gnu, linux,
> -linux-gnu, hiux, hpux, iris, irix, isc, luna, lynxos, mach, minix, msdos, mvs,
> -netbsd, newsos, nindy, ns, osf, osfrose, ptx, riscix, riscos, rtu, sco, sim,
> -solaris, sunos, sym, sysv, udi, ultrix, unicos, uniplus, unos, vms, vsta,
> -vxworks, winnt, xenix.
> -@end quotation
> -
> -@noindent
> -You can omit the system type; then @file{configure} guesses the
> -operating system from the CPU and company.
> -
> -You can add a version number to the system type; this may or may not
> -make a difference.  For example, you can write @samp{bsd4.3} or
> -@samp{bsd4.4} to distinguish versions of BSD@.  In practice, the version
> -number is most needed for @samp{sysv3} and @samp{sysv4}, which are often
> -treated differently.
> -
> -@samp{linux-gnu} is the canonical name for the GNU/Linux target; however
> -GCC will also accept @samp{linux}.  The version of the kernel in use is
> -not relevant on these systems.  A suffix such as @samp{libc1} or @samp{aout}
> -distinguishes major versions of the C library; all of the suffixed versions
> -are obsolete.
> -
> -If you specify an impossible combination such as @samp{i860-dg-vms},
> -then you may get an error message from @file{configure}, or it may
> -ignore part of the information and do the best it can with the rest.
> -@file{configure} always prints the canonical name for the alternative
> -that it used.  GCC does not support all possible alternatives.
> -
> -Often a particular model of machine has a name.  Many machine names are
> -recognized as aliases for CPU/company combinations.  Thus, the machine
> -name @samp{sun3}, mentioned above, is an alias for @samp{m68k-sun}.
> -Sometimes we accept a company name as a machine name, when the name is
> -popularly used for a particular machine.  Here is a table of the known
> -machine names:
> -
> -@quotation
> -3300, 3b1, 3b@var{n}, 7300, altos3068, altos,
> -apollo68, att-7300, balance,
> -convex-c@var{n}, crds, decstation-3100,
> -decstation, delta, encore,
> -fx2800, gmicro, hp7@var{nn}, hp8@var{nn},
> -hp9k2@var{nn}, hp9k3@var{nn}, hp9k7@var{nn},
> -hp9k8@var{nn}, iris4d, iris, isi68,
> -m3230, magnum, merlin, miniframe,
> -mmax, news-3600, news800, news, next,
> -pbd, pc532, pmax, powerpc, powerpcle, ps2, risc-news,
> -rtpc, sun2, sun386i, sun386, sun3,
> -sun4, symmetry, tower-32, tower.
> -@end quotation
> -
> -@noindent
> -Remember that a machine name specifies both the cpu type and the company
> -name.
> diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
> index 261951848d4..f0591e06b3e 100644
> --- a/gcc/doc/install.texi
> +++ b/gcc/doc/install.texi
> @@ -36,9 +36,6 @@
>   @ifset binarieshtml
>   @settitle Installing GCC: Binaries
>   @end ifset
> -@ifset oldhtml
> -@settitle Installing GCC: Old documentation
> -@end ifset
>   @ifset gfdlhtml
>   @settitle Installing GCC: GNU Free Documentation License
>   @end ifset
> @@ -62,7 +59,6 @@
>   @set testhtml
>   @set finalinstallhtml
>   @set binarieshtml
> -@set oldhtml
>   @set gfdlhtml
>   @end ifnothtml
>   
> @@ -120,8 +116,6 @@ Free Documentation License}''.
>   * Specific::        Host/target specific installation notes for GCC.
>   * Binaries::        Where to get pre-compiled binaries.
>   
> -* Old::             Old installation documentation.
> -
>   * GNU Free Documentation License:: How you can copy and share this manual.
>   * Concept Index::   This index has two entries.
>   @end menu
> @@ -3446,7 +3440,7 @@ links to GNU Fortran binaries for several platforms.
>   @c ***Specific****************************************************************
>   @ifnothtml
>   @comment node-name,     next,          previous, up
> -@node    Specific, Old, Binaries, Top
> +@node    Specific, GNU Free Documentation License, Binaries, Top
>   @end ifnothtml
>   @ifset specifichtml
>   @ifnothtml
> @@ -5140,18 +5134,6 @@ automatically.
>   @end ifhtml
>   @end ifset
>   
> -@c ***Old documentation******************************************************
> -@ifset oldhtml
> -@include install-old.texi
> -@html
> -<hr />
> -<p>
> -@end html
> -@ifhtml
> -@uref{./index.html,,Return to the GCC Installation page}
> -@end ifhtml
> -@end ifset
> -
>   @c ***GFDL********************************************************************
>   @ifset gfdlhtml
>   @include fdl.texi

Re: [PATCH][DOCS] Remove install-old.texi

[Joseph Myers]

On Mon, 17 May 2021, Martin Liška wrote:

> -@enumerate
> -@item
> -If you have chosen a configuration for GCC which requires other GNU
> -tools (such as GAS or the GNU linker) instead of the standard system
> -tools, install the required tools in the build directory under the names
> -@file{as}, @file{ld} or whatever is appropriate.

This bit is obsoleted by --with-build-time-tools (putting tools in the 
build directory was needed in some cases before that option was added).

> -@item
> -Specify the host, build and target machine configurations.  You do this
> -when you run the @file{configure} script.

But install.texi doesn't appear to have such documentation of what host, 
build and target are and how to specify them.

> -Here are the possible CPU types:
> -
> -@quotation
> -@c gmicro, fx80, spur and tahoe omitted since they don't work.
> -1750a, a29k, alpha, arm, avr, c@var{n}, clipper, dsp16xx, elxsi, fr30, h8300,
> -hppa1.0, hppa1.1, i370, i386, i486, i586, i686, i786, i860, i960, ip2k, m32r,
> -m68000, m68k, m88k, mcore, mips, mipsel, mips64, mips64el,
> -mn10200, mn10300, ns32k, pdp11, powerpc, powerpcle, romp, rs6000, sh, sparc,
> -sparclite, sparc64, v850, vax, we32k.
> -@end quotation

The very outdated list of specific names may not be very useful now, 
although arguably there *should* be a current list of supported targets 
(closer to that in config-list.mk, or at least a list of supported CPU 
names and another list of supported OS names) in the installation 
documentation.

> -Often a particular model of machine has a name.  Many machine names are
> -recognized as aliases for CPU/company combinations.  Thus, the machine

All such machine names can probably be considered obsolete; the main case 
to document is CPU-SYSTEM (no company mentioned), not machine name aliases 
(and mention somewhere that config.sub produces the canonical version of a 
name).

-- 
Joseph S. Myers
joseph@codesourcery.com

Re: [PATCH][DOCS] Remove install-old.texi

[Martin Liška]

[-- Attachment #1: Type: text/plain, Size: 2118 bytes --]

On 5/18/21 12:30 AM, Joseph Myers wrote:
> On Mon, 17 May 2021, Martin Liška wrote:
> 
>> -@enumerate
>> -@item
>> -If you have chosen a configuration for GCC which requires other GNU
>> -tools (such as GAS or the GNU linker) instead of the standard system
>> -tools, install the required tools in the build directory under the names
>> -@file{as}, @file{ld} or whatever is appropriate.
> 
> This bit is obsoleted by --with-build-time-tools (putting tools in the
> build directory was needed in some cases before that option was added).
> 
>> -@item
>> -Specify the host, build and target machine configurations.  You do this
>> -when you run the @file{configure} script.
> 
> But install.texi doesn't appear to have such documentation of what host,
> build and target are and how to specify them.
> 
>> -Here are the possible CPU types:
>> -
>> -@quotation
>> -@c gmicro, fx80, spur and tahoe omitted since they don't work.
>> -1750a, a29k, alpha, arm, avr, c@var{n}, clipper, dsp16xx, elxsi, fr30, h8300,
>> -hppa1.0, hppa1.1, i370, i386, i486, i586, i686, i786, i860, i960, ip2k, m32r,
>> -m68000, m68k, m88k, mcore, mips, mipsel, mips64, mips64el,
>> -mn10200, mn10300, ns32k, pdp11, powerpc, powerpcle, romp, rs6000, sh, sparc,
>> -sparclite, sparc64, v850, vax, we32k.
>> -@end quotation
> 
> The very outdated list of specific names may not be very useful now,
> although arguably there *should* be a current list of supported targets
> (closer to that in config-list.mk, or at least a list of supported CPU
> names and another list of supported OS names) in the installation
> documentation.
> 
>> -Often a particular model of machine has a name.  Many machine names are
>> -recognized as aliases for CPU/company combinations.  Thus, the machine
> 
> All such machine names can probably be considered obsolete; the main case
> to document is CPU-SYSTEM (no company mentioned), not machine name aliases
> (and mention somewhere that config.sub produces the canonical version of a
> name).
> 

All right, the suggested changes make sense to me and I've just tried to address
them in the patch.

Thoughts?
Martin

[-- Attachment #2: 0001-docs-port-old-intall.texi-part-to-install.texi.patch --]
[-- Type: text/x-patch, Size: 4066 bytes --]

From a5af817b5769abf1e58119b9b07968ca0c40bb9d Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Tue, 18 May 2021 11:57:47 +0200
Subject: [PATCH] docs: port old-intall.texi part to install.texi

gcc/ChangeLog:

	* doc/install.texi: Port relevant part from install-old.texi
	and re-generate list of CPUs and systems.
---
 gcc/doc/install.texi | 70 +++++++++++++++++++++++++++++++++++---------
 1 file changed, 56 insertions(+), 14 deletions(-)

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index f0591e06b3e..92c7d5fb279 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -697,23 +697,65 @@ The default value is @uref{https://gcc.gnu.org/,,https://gcc.gnu.org/}.
 
 @end table
 
-@heading Target specification
-@itemize @bullet
-@item
-GCC has code to correctly determine the correct value for @var{target}
-for nearly all native systems.  Therefore, we highly recommend you do
-not provide a configure target when configuring a native compiler.
+@heading Host, Build and Target specification
 
-@item
-@var{target} must be specified as @option{--target=@var{target}}
-when configuring a cross compiler; examples of valid targets would be
-m68k-elf, sh-elf, etc.
+Specify the host, build and target machine configurations.  You do this
+when you run the @file{configure} script.
 
-@item
-Specifying just @var{target} instead of @option{--target=@var{target}}
-implies that the host defaults to @var{target}.
-@end itemize
+The @dfn{build} machine is the system which you are using, the
+@dfn{host} machine is the system where you want to run the resulting
+compiler (normally the build machine), and the @dfn{target} machine is
+the system for which you want the compiler to generate code.
+
+If you are building a compiler to produce code for the machine it runs
+on (a native compiler), you normally do not need to specify any operands
+to @file{configure}; it will try to guess the type of machine you are on
+and use that as the build, host and target machines.  So you don't need
+to specify a configuration when building a native compiler unless
+@file{configure} cannot figure out what your configuration is or guesses
+wrong.
+
+In those cases, specify the build machine's @dfn{configuration name}
+with the @option{--host} option; the host and target will default to be
+the same as the host machine.
+
+Here is an example:
+
+@smallexample
+./configure --host=x86_64-pc-linux-gnu
+@end smallexample
 
+A configuration name may be canonical or it may be more or less
+abbreviated (@file{config.sub} script produces canonical versions).
+
+A canonical configuration name has three parts, separated by dashes.
+It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.
+
+Here are the possible CPU types:
+
+@quotation
+aarch64, alpha, alpha64, amdgcn, arc, arceb, arm, avr, bfin, bpf, c6x, cr16,
+cris, csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0, hppa64,
+i486, i686, ia64, iq2000, lm32, m32c, m32r, m32rle, m68k, mcore, microblaze,
+mips, mips64, mips64el, mips64octeon, mips64orion, mips64vr, mipsel, mipsisa32,
+mipsisa32r2, mipsisa64, mipsisa64r2, mipsisa64r2el, mipsisa64sb1, mipsisa64sr71k,
+mipstx39, mmix, mn10300, moxie, msp430, nds32be, nds32le, nios2, nvptx, or1k,
+pdp11, powerpc, powerpc64, powerpcle, ppc, pru, riscv32, riscv64, rl78, rx,
+s390, s390x, sh, shle, sparc, sparc64, tilegx, tilegxbe, tilepro, v850, v850e,
+v850e1, vax, visium, x86_64, xstormy16, xtensa
+@end quotation
+
+Here is a list of system types:
+
+@quotation
+aix7.1, aix7.2, amdhsa, androideabi, aout, cygwin, darwin, darwin10, darwin7,
+darwin8, darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
+elfbare, elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3,
+hpux11.9, linux, linux_altivec, lynxos, mingw32, mingw32crt, mmixware, msdosdjgpp,
+musl, netbsd, netbsdelf, netbsdelf9, none, openbsd, qnx, rtems, solaris2.11,
+symbianelf, tpf, uclibc, uclinux, uclinux_eabi, vms, vxworks, vxworksae,
+vxworksmils
+@end quotation
 
 @heading Options specification
 
-- 
2.31.1

Re: [PATCH][DOCS] Remove install-old.texi

[Joseph Myers]

On Tue, 18 May 2021, Martin Liška wrote:

> +@quotation
> +aix7.1, aix7.2, amdhsa, androideabi, aout, cygwin, darwin, darwin10, darwin7,
> +darwin8, darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
> +elfbare, elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3,
> +hpux11.9, linux, linux_altivec, lynxos, mingw32, mingw32crt, mmixware, msdosdjgpp,
> +musl, netbsd, netbsdelf, netbsdelf9, none, openbsd, qnx, rtems, solaris2.11,
> +symbianelf, tpf, uclibc, uclinux, uclinux_eabi, vms, vxworks, vxworksae,
> +vxworksmils
> +@end quotation

I'm not sure where this list comes from, but I'd expect "linux" to be the 
canonical "linux-gnu", along with "linux-uclibc", "linux-android", 
"linux-musl" ("uclibc" etc. aren't system names on their own) and variants 
with "eabi" or "eabihf" on the end (see what config.guess produces for 
Arm).

-- 
Joseph S. Myers
joseph@codesourcery.com

Re: [PATCH][DOCS] Remove install-old.texi

[Martin Liška]

On 5/18/21 10:18 PM, Joseph Myers wrote:
> On Tue, 18 May 2021, Martin Liška wrote:
> 
>> +@quotation
>> +aix7.1, aix7.2, amdhsa, androideabi, aout, cygwin, darwin, darwin10, darwin7,
>> +darwin8, darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
>> +elfbare, elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3,
>> +hpux11.9, linux, linux_altivec, lynxos, mingw32, mingw32crt, mmixware, msdosdjgpp,
>> +musl, netbsd, netbsdelf, netbsdelf9, none, openbsd, qnx, rtems, solaris2.11,
>> +symbianelf, tpf, uclibc, uclinux, uclinux_eabi, vms, vxworks, vxworksae,
>> +vxworksmils
>> +@end quotation
> 
> I'm not sure where this list comes from

I split parts in contrib/config-list.mk and printed them.

> but I'd expect "linux" to be the
> canonical "linux-gnu", along with "linux-uclibc", "linux-android",
> "linux-musl" ("uclibc" etc. aren't system names on their own) and variants
> with "eabi" or "eabihf" on the end (see what config.guess produces for
> Arm).

One needs an Arm machine for that. Do you know about a better way how to get
list of all systems?

Thanks,
Martin

> 

Re: [PATCH][DOCS] Remove install-old.texi

[Joseph Myers]

On Wed, 19 May 2021, Martin Liška wrote:

> > I'm not sure where this list comes from
> 
> I split parts in contrib/config-list.mk and printed them.
> 
> > but I'd expect "linux" to be the
> > canonical "linux-gnu", along with "linux-uclibc", "linux-android",
> > "linux-musl" ("uclibc" etc. aren't system names on their own) and variants
> > with "eabi" or "eabihf" on the end (see what config.guess produces for
> > Arm).
> 
> One needs an Arm machine for that. Do you know about a better way how to get
> list of all systems?

Looking at the config.sub / config.guess testsuites (in config.git) will 
provide lists of many systems (not all supported by GCC) (and the code of 
config.guess may also help show what the Arm variants are).  Looking at 
config.gcc to see what it matches against may also be helpful (but then 
use config.sub to get the canonical form of a target triplet).

-- 
Joseph S. Myers
joseph@codesourcery.com

Re: [PATCH][DOCS] Remove install-old.texi

[Martin Liška]

On 5/19/21 4:49 PM, Joseph Myers wrote:
> On Wed, 19 May 2021, Martin Liška wrote:
> 
>>> I'm not sure where this list comes from
>>
>> I split parts in contrib/config-list.mk and printed them.
>>
>>> but I'd expect "linux" to be the
>>> canonical "linux-gnu", along with "linux-uclibc", "linux-android",
>>> "linux-musl" ("uclibc" etc. aren't system names on their own) and variants
>>> with "eabi" or "eabihf" on the end (see what config.guess produces for
>>> Arm).
>>
>> One needs an Arm machine for that. Do you know about a better way how to get
>> list of all systems?
> 
> Looking at the config.sub / config.guess testsuites (in config.git) will
> provide lists of many systems (not all supported by GCC) (and the code of
> config.guess may also help show what the Arm variants are).  Looking at
> config.gcc to see what it matches against may also be helpful (but then
> use config.sub to get the canonical form of a target triplet).

All right, I've taken all targets mentioned in contrib/config-list.mk and
called config.sub for them.

Then I've taken first parts[0] as a CPU name and '-'.join(parts[2:]) as system name.
That gets me:

CPUs:
aarch64, alpha, alpha64, amdgcn, arc, arceb, arm, avr, bfin, bpf, cr16, cris, csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0, hppa64, i486, i686, ia64, iq2000, lm32, m32c, m32r, m32rle, m68k, mcore, microblaze, mips, mips64, mips64el, mips64octeon, mips64orion, mips64vr, mipsel, mipsisa32, mipsisa32r2, mipsisa64, mipsisa64r2, mipsisa64r2el, mipsisa64sb1, mipsisa64sr71k, mipstx39, mmix, mn10300, moxie, msp430, nds32be, nds32le, nios2, nvptx, or1k, pdp11, powerpc, powerpc64, powerpcle, pru, riscv32, riscv64, rl78, rx, s390, s390x, sh, shle, sparc, sparc64, tic6x, tilegx, tilegxbe, tilepro, v850, v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa


SYSTEMSs:
aix7.1, aix7.2, amdhsa, aout, cygwin, darwin, darwin10, darwin7, darwin8, darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32, elfbare, elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3, hpux11.9, kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu, linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt, mmixware, msdosdjgpp, netbsd, netbsdelf, netbsdelf9, nto-qnx, openbsd, rtems, solaris2.11, symbianelf, tpf, uclinux, uclinux_eabi, vms, vxworks, vxworksae, vxworksmils


Is it a reasonable list?
Thanks,
Martin

> 

Re: [PATCH][DOCS] Remove install-old.texi

[Joseph Myers]

On Fri, 21 May 2021, Martin Liška wrote:

> CPUs:
> aarch64, alpha, alpha64, amdgcn, arc, arceb, arm, avr, bfin, bpf, cr16, cris,
> csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0, hppa64, i486,
> i686, ia64, iq2000, lm32, m32c, m32r, m32rle, m68k, mcore, microblaze, mips,
> mips64, mips64el, mips64octeon, mips64orion, mips64vr, mipsel, mipsisa32,
> mipsisa32r2, mipsisa64, mipsisa64r2, mipsisa64r2el, mipsisa64sb1,
> mipsisa64sr71k, mipstx39, mmix, mn10300, moxie, msp430, nds32be, nds32le,
> nios2, nvptx, or1k, pdp11, powerpc, powerpc64, powerpcle, pru, riscv32,
> riscv64, rl78, rx, s390, s390x, sh, shle, sparc, sparc64, tic6x, tilegx,
> tilegxbe, tilepro, v850, v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa

I think it makes sense to include some other variants in this list that 
are matched by config.gcc to control something about how the compiler is 
configured.  That includes at least some endian control variants (in 
addition to those you already have): aarch64_be, armeb, microblazeel, 
riscv32be, riscv64be.  powerpc64le is also an important powerpc variant.

> aix7.1, aix7.2, amdhsa, aout, cygwin, darwin, darwin10, darwin7, darwin8,
> darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32, elfbare,
> elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3,
> hpux11.9, kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu,
> linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt,
> mmixware, msdosdjgpp, netbsd, netbsdelf, netbsdelf9, nto-qnx, openbsd, rtems,
> solaris2.11, symbianelf, tpf, uclinux, uclinux_eabi, vms, vxworks, vxworksae,
> vxworksmils

Where an OS version is included here (aix, darwin, freebsd, hpux, 
netbsdelf, solaris), I think it's better to say @var{version}, to indicate 
for which OSes such a version number is meaningful, than to list specific 
version numbers.

linux-gnueabi and linux-gnueabihf (for Arm) are appropriate to list here.

-- 
Joseph S. Myers
joseph@codesourcery.com

Re: [PATCH][DOCS] Remove install-old.texi

[Martin Liška]

[-- Attachment #1: Type: text/plain, Size: 2167 bytes --]

On 5/24/21 10:09 PM, Joseph Myers wrote:
> On Fri, 21 May 2021, Martin Liška wrote:
> 
>> CPUs:
>> aarch64, alpha, alpha64, amdgcn, arc, arceb, arm, avr, bfin, bpf, cr16, cris,
>> csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0, hppa64, i486,
>> i686, ia64, iq2000, lm32, m32c, m32r, m32rle, m68k, mcore, microblaze, mips,
>> mips64, mips64el, mips64octeon, mips64orion, mips64vr, mipsel, mipsisa32,
>> mipsisa32r2, mipsisa64, mipsisa64r2, mipsisa64r2el, mipsisa64sb1,
>> mipsisa64sr71k, mipstx39, mmix, mn10300, moxie, msp430, nds32be, nds32le,
>> nios2, nvptx, or1k, pdp11, powerpc, powerpc64, powerpcle, pru, riscv32,
>> riscv64, rl78, rx, s390, s390x, sh, shle, sparc, sparc64, tic6x, tilegx,
>> tilegxbe, tilepro, v850, v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa
> 
> I think it makes sense to include some other variants in this list that
> are matched by config.gcc to control something about how the compiler is
> configured.  That includes at least some endian control variants (in
> addition to those you already have): aarch64_be, armeb, microblazeel,
> riscv32be, riscv64be.  powerpc64le is also an important powerpc variant.

Makes sense to me.

> 
>> aix7.1, aix7.2, amdhsa, aout, cygwin, darwin, darwin10, darwin7, darwin8,
>> darwin9, eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32, elfbare,
>> elfoabi, freebsd4, freebsd6, gnu, hpux, hpux10.1, hpux11.0, hpux11.3,
>> hpux11.9, kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu,
>> linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt,
>> mmixware, msdosdjgpp, netbsd, netbsdelf, netbsdelf9, nto-qnx, openbsd, rtems,
>> solaris2.11, symbianelf, tpf, uclinux, uclinux_eabi, vms, vxworks, vxworksae,
>> vxworksmils
> 
> Where an OS version is included here (aix, darwin, freebsd, hpux,
> netbsdelf, solaris), I think it's better to say @var{version}, to indicate
> for which OSes such a version number is meaningful, than to list specific
> version numbers.
> 
> linux-gnueabi and linux-gnueabihf (for Arm) are appropriate to list here.
> 

Thank you for the review and help.

There's an updated version of the patch, is it fine now?
Martin

[-- Attachment #2: 0001-docs-port-old-intall.texi-part-to-install.texi.patch --]
[-- Type: text/x-patch, Size: 4155 bytes --]

From cc7f783dea512276fb996fcd342602d87530a4d8 Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Tue, 18 May 2021 11:57:47 +0200
Subject: [PATCH] docs: port old-intall.texi part to install.texi

gcc/ChangeLog:

	* doc/install.texi: Port relevant part from install-old.texi
	and re-generate list of CPUs and systems.
---
 gcc/doc/install.texi | 72 +++++++++++++++++++++++++++++++++++---------
 1 file changed, 58 insertions(+), 14 deletions(-)

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index f0591e06b3e..7c907feb02a 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -697,23 +697,67 @@ The default value is @uref{https://gcc.gnu.org/,,https://gcc.gnu.org/}.
 
 @end table
 
-@heading Target specification
-@itemize @bullet
-@item
-GCC has code to correctly determine the correct value for @var{target}
-for nearly all native systems.  Therefore, we highly recommend you do
-not provide a configure target when configuring a native compiler.
+@heading Host, Build and Target specification
 
-@item
-@var{target} must be specified as @option{--target=@var{target}}
-when configuring a cross compiler; examples of valid targets would be
-m68k-elf, sh-elf, etc.
+Specify the host, build and target machine configurations.  You do this
+when you run the @file{configure} script.
 
-@item
-Specifying just @var{target} instead of @option{--target=@var{target}}
-implies that the host defaults to @var{target}.
-@end itemize
+The @dfn{build} machine is the system which you are using, the
+@dfn{host} machine is the system where you want to run the resulting
+compiler (normally the build machine), and the @dfn{target} machine is
+the system for which you want the compiler to generate code.
+
+If you are building a compiler to produce code for the machine it runs
+on (a native compiler), you normally do not need to specify any operands
+to @file{configure}; it will try to guess the type of machine you are on
+and use that as the build, host and target machines.  So you don't need
+to specify a configuration when building a native compiler unless
+@file{configure} cannot figure out what your configuration is or guesses
+wrong.
+
+In those cases, specify the build machine's @dfn{configuration name}
+with the @option{--host} option; the host and target will default to be
+the same as the host machine.
+
+Here is an example:
+
+@smallexample
+./configure --host=x86_64-pc-linux-gnu
+@end smallexample
 
+A configuration name may be canonical or it may be more or less
+abbreviated (@file{config.sub} script produces canonical versions).
+
+A canonical configuration name has three parts, separated by dashes.
+It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.
+
+Here are the possible CPU types:
+
+@quotation
+aarch64, aarch64_be, alpha, alpha64, amdgcn, arc, arceb, arm, armeb, avr, bfin,
+bpf, cr16, cris, csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0,
+hppa64, i486, i686, ia64, iq2000, lm32, m32c, m32r, m32rle, m68k, mcore,
+microblaze, microblazeel, mips, mips64, mips64el, mips64octeon, mips64orion,
+mips64vr, mipsel, mipsisa32, mipsisa32r2, mipsisa64, mipsisa64r2,
+mipsisa64r2el, mipsisa64sb1, mipsisa64sr71k, mipstx39, mmix, mn10300, moxie,
+msp430, nds32be, nds32le, nios2, nvptx, or1k, pdp11, powerpc, powerpc64,
+powerpc64le, powerpcle, pru, riscv32, riscv32be, riscv64, riscv64be, rl78, rx,
+s390, s390x, sh, shle, sparc, sparc64, tic6x, tilegx, tilegxbe, tilepro, v850,
+v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa
+@end quotation
+
+Here is a list of system types:
+
+@quotation
+aix@var{version}, amdhsa, aout, cygwin, darwin@var{version}
+eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
+elfbare, elfoabi, freebsd@var{version}gnu, hpux, hpux@var{version},
+kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu,
+linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt,
+mmixware, msdosdjgpp, netbsd, netbsdelf@var{version}, nto-qnx, openbsd,
+rtems, solaris@var{version}, symbianelf, tpf, uclinux, uclinux_eabi, vms,
+vxworks, vxworksae, vxworksmils
+@end quotation
 
 @heading Options specification
 
-- 
2.31.1

Re: [PATCH][DOCS] Remove install-old.texi

[Joseph Myers]

On Tue, 25 May 2021, Martin Liška wrote:

> +@quotation
> +aix@var{version}, amdhsa, aout, cygwin, darwin@var{version}

Missing comma at the end of this line.

> +eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
> +elfbare, elfoabi, freebsd@var{version}gnu, hpux, hpux@var{version},

Missing ", " between "freebsd@var{version}" and "gnu".

The patch is OK with those fixes.  There may be further cleanup that can 
be done to these lists, but they're certainly a lot better than the 
versions currently in install-old.texi.

-- 
Joseph S. Myers
joseph@codesourcery.com