Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Thomas Boehne]

Hi gcc-developers, 

I was trying to look up some information about the installation of gcc
on http://gcc.gnu.org/install/ and found out the the "Building" link
(http://gcc.gnu.org/install/build.html) was dead. I checked out
wwwdocs from CVS (as suggested) but I could not find the appropriate
files anywhere... Am I missing something in the CVS tree, or did the
website source move to the SVN?

Cheers,
Thomas

-- 
Jäger Computergesteuerte Messtechnik GmbH
Thomas Böhne
Rheinstraße 2-4
64653 Lorsch
Germany
Phone: +49-6251-9632-0

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Ben Elliston]

Hi.

> I was trying to look up some information about the installation of
> gcc on http://gcc.gnu.org/install/ and found out the the "Building"
> link (http://gcc.gnu.org/install/build.html) was dead. I checked out
> wwwdocs from CVS (as suggested) but I could not find the appropriate
> files anywhere... Am I missing something in the CVS tree, or did the
> website source move to the SVN?

Good find, thanks.  For install/build.html, for instance:

revision 1.26
date: 2001/05/23 06:02:05;  author: gerald;  state: dead;  lines: +0 -0
Remove all install documentation in HTML format, as this now resides in
gcc/doc/install.texi.

Gerald removed these files for the reason shown above.  However I'm
not sure what we should do about it.  Perhaps provide a small page
explaining where to get installation docs.

Cheers, Ben

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Joseph S. Myers]

On Tue, 21 Feb 2006, Ben Elliston wrote:

> Good find, thanks.  For install/build.html, for instance:
> 
> revision 1.26
> date: 2001/05/23 06:02:05;  author: gerald;  state: dead;  lines: +0 -0
> Remove all install documentation in HTML format, as this now resides in
> gcc/doc/install.texi.
> 
> Gerald removed these files for the reason shown above.  However I'm
> not sure what we should do about it.  Perhaps provide a small page
> explaining where to get installation docs.

This is not the relevant reference; the files should be generated by 
install.texi2html.  See, instead, 
<http://gcc.gnu.org/ml/gccadmin/2006-q1/msg00132.html>:

/tmp/gcc-doc-update.4743/gcc/gcc/doc/install.texi:1724: Footnote defined without parent node.
makeinfo: Removing output file `/www/gcc/htdocs-preformatted/install/build.html' due to errors; use --force to preserve.

[...]
Removing obsolete file ./install/build.html

I suspect

r111295 | bonzini | 2006-02-20 08:29:17 +0000 (Mon, 20 Feb 2006) | 59 lines

of being the responsible patch.

I've installed the following patch to ensure that install.texi2html halts 
with error status (and so update_web_docs_svn does so) when such an error 
occurs.

Index: doc/install.texi2html
===================================================================
--- doc/install.texi2html	(revision 111331)
+++ doc/install.texi2html	(working copy)
@@ -5,13 +5,15 @@
 # $SOURCEDIR and $DESTDIR, resp., refer to the directory containing
 # the texinfo source and the directory to put the HTML version in.
 #
-# (C) 2001 Free Software Foundation
+# (C) 2001, 2003, 2006 Free Software Foundation
 # Originally by Gerald Pfeifer <pfeifer@dbai.tuwien.ac.at>, June 2001.
 #
 # This script is Free Software, and it can be copied, distributed and
 # modified as defined in the GNU General Public License.  A copy of
 # its license can be downloaded from http://www.gnu.org/copyleft/gpl.html
 
+set -e
+
 SOURCEDIR=${SOURCEDIR-.}
 DESTDIR=${DESTDIR-HTML}
 
Index: ChangeLog
===================================================================
--- ChangeLog	(revision 111331)
+++ ChangeLog	(working copy)
@@ -1,3 +1,7 @@
+2006-02-21  Joseph S. Myers  <joseph@codesourcery.com>
+
+	* doc/install.texi2html: Use set -e.
+
 2006-02-21  Richard Sandiford  <richard@codesourcery.com>
 
 	* doc/tm.texi (ASM_OUTPUT_SHARED_COMMON, ASM_OUTPUT_SHARED_BSS)

-- 
Joseph S. Myers               http://www.srcf.ucam.org/~jsm28/gcc/
    jsm@polyomino.org.uk (personal mail)
    joseph@codesourcery.com (CodeSourcery mail)
    jsm28@gcc.gnu.org (Bugzilla assignments and CCs)

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Paolo Bonzini]

There's a requirement to not use footnotes in install.texi, apparently. 
  Also, I did not know about install.texi2html so I added a note on it.

Ok to install?

Paolo

2006-02-22  Paolo Bonzini  <bonzini@gnu.org>

	* install.texi: Add notes on install.texi2html.
	(Building in parallel): Do not use footnotes.

Index: install.texi
===================================================================
--- install.texi        (revision 111328)
+++ install.texi        (working copy)
@@ -46,6 +46,11 @@
  @c 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
  @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com

+@c IMPORTANT: whenever you modify this file, run `install.texi2html' to
+@c test the generation of HTML documents for the gcc.gnu.org web pages.
+@c
+@c Do not use @footnote{} in this file as it breaks install.texi2html!
+
  @c Include everything if we're not making html
  @ifnothtml
  @set indexhtml
@@ -1720,9 +1725,9 @@ compilation options.  Check your target'

  @section Building in parallel

-You can use @samp{make -j 2}@footnote{Only supported by GNU Make 3.79
-  and above, which is anyway necessary to build GCC.}, instead of 
@samp{make},
-to build GCC in parallel.  You can also specify a bigger number, and
+GNU Make 3.79 and above, which is necessary to build GCC, support
+building in parallel.  To activate this, you can use @samp{make -j 2}
+instead of @samp{make}.  You can also specify a bigger number, and
  in most cases using a value greater than the number of processors in
  your machine will result in fewer and shorter I/O latency hits, thus
  improving overall throughput; this is especially true for slow drives

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Paolo Bonzini]

There's a requirement to not use footnotes in install.texi, apparently. 
  Also, I did not know about install.texi2html so I added a note on it.

Ok to install?

Paolo

2006-02-22  Paolo Bonzini  <bonzini@gnu.org>

	* install.texi: Add notes on install.texi2html.
	(Building in parallel): Do not use footnotes.

Index: install.texi
===================================================================
--- install.texi        (revision 111328)
+++ install.texi        (working copy)
@@ -46,6 +46,11 @@
  @c 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
  @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com

+@c IMPORTANT: whenever you modify this file, run `install.texi2html' to
+@c test the generation of HTML documents for the gcc.gnu.org web pages.
+@c
+@c Do not use @footnote{} in this file as it breaks install.texi2html!
+
  @c Include everything if we're not making html
  @ifnothtml
  @set indexhtml
@@ -1720,9 +1725,9 @@ compilation options.  Check your target'

  @section Building in parallel

-You can use @samp{make -j 2}@footnote{Only supported by GNU Make 3.79
-  and above, which is anyway necessary to build GCC.}, instead of 
@samp{make},
-to build GCC in parallel.  You can also specify a bigger number, and
+GNU Make 3.79 and above, which is necessary to build GCC, support
+building in parallel.  To activate this, you can use @samp{make -j 2}
+instead of @samp{make}.  You can also specify a bigger number, and
  in most cases using a value greater than the number of processors in
  your machine will result in fewer and shorter I/O latency hits, thus
  improving overall throughput; this is especially true for slow drives

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Joseph S. Myers]

On Wed, 22 Feb 2006, Paolo Bonzini wrote:

> There's a requirement to not use footnotes in install.texi, apparently.  Also,
> I did not know about install.texi2html so I added a note on it.
> 
> Ok to install?

OK.

>  @c 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.

Remember of course when committing to update both copyright notices.

-- 
Joseph S. Myers               http://www.srcf.ucam.org/~jsm28/gcc/
    jsm@polyomino.org.uk (personal mail)
    joseph@codesourcery.com (CodeSourcery mail)
    jsm28@gcc.gnu.org (Bugzilla assignments and CCs)

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Gerald Pfeifer]

Hi Paolo,

thanks for the patch.  I just saw Joseph's okay, but I believe there
is one minor detail left.

On Wed, 22 Feb 2006, Paolo Bonzini wrote:
> +GNU Make 3.79 and above, which is necessary to build GCC, support
> +building in parallel.

Specifically, in the sentence above we have "which is" (singular)
versus "support" (plural) which confused me a bit when first reading
the change.

Joseph as a native speaker will be in a much better position to advise
whether to use singular or plural here, but I believe the two uses should
be in sync.

Gerald

Re: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Paolo Bonzini]

Gerald Pfeifer wrote:
> Hi Paolo,
>
> thanks for the patch.  I just saw Joseph's okay, but I believe there
> is one minor detail left.
>
> On Wed, 22 Feb 2006, Paolo Bonzini wrote:
>   
>> +GNU Make 3.79 and above, which is necessary to build GCC, support
>> +building in parallel.
>>     
>
> Specifically, in the sentence above we have "which is" (singular)
> versus "support" (plural) which confused me a bit when first reading
> the change.
>
> Joseph as a native speaker will be in a much better position to advise
> whether to use singular or plural here, but I believe the two uses should
> be in sync.
>   
If rephrasing the sentence as

GNU Make supports building in parallel starting from version 3.79, which 
is anyway necessary to build GCC.

is ok, I'm pretty sure this is correct ("which" refers to "version").

Paolo

RE: Dead link http://gcc.gnu.org/install/build.html on http://gcc.gnu.org/install/

[Dave Korn]

On 22 February 2006 16:40, Paolo Bonzini wrote:

> Gerald Pfeifer wrote:
>> Hi Paolo,
>> 
>> thanks for the patch.  I just saw Joseph's okay, but I believe there
>> is one minor detail left.
>> 
>> On Wed, 22 Feb 2006, Paolo Bonzini wrote:
>> 
>>> +GNU Make 3.79 and above, which is necessary to build GCC, support
>>> +building in parallel. 
>>> 
>> 
>> Specifically, in the sentence above we have "which is" (singular)
>> versus "support" (plural) which confused me a bit when first reading
>> the change.
>> 
>> Joseph as a native speaker will be in a much better position to advise
>> whether to use singular or plural here, but I believe the two uses should
>> be in sync. 
>> 
> If rephrasing the sentence as
> 
> GNU Make supports building in parallel starting from version 3.79, which
> is anyway necessary to build GCC.
> 
> is ok, I'm pretty sure this is correct ("which" refers to "version").
> 
> Paolo


  Yep, I think the clearest way to rephrase it would be

GNU Make 3.79 (which is the minimum version required to build GCC) and above,
support building in parallel. 

thereby removing the confusion between the requirement (singular) and the set
of versions that fulfill that requirement (plural).


    cheers,
      DaveK
-- 
Can't think of a witty .sigline today....