[m-rev.] for review: changes to download pages (DIFF)

[Julien Fischer]

On Fri, 30 Sep 2005, Ian MacLarty wrote:

> Index: README
> ===================================================================
> RCS file: README
> diff -N README
> --- /dev/null	1 Jan 1970 00:00:00 -0000
> +++ README	30 Sep 2005 05:12:45 -0000
> @@ -0,0 +1,63 @@
> +This directory contains the source for the Mercury website.
> +
> +BUILDING THE WEBSITE
> +
> +The site is written in PHP3 which is converted to HTML before being uploaded
> +to the web server (unlike the usual way php is used where it generates HTML
> +dynamically).
> +
> +Type `make' to build all the html files from the php3 source.  The php3
> +executable should be located in /usr/lib/cgi-bin.  To specify a different
> +location for the php3 executable, set the PHP3 environment variable to the
> +path of the php3 executable.
> +
> +CGI SCRIPTS
> +
> +The cgi-bin directory holds CGI scripts necessary for some dynamic content
> +on the website, such as the currently available release of the day.
> +
> +The Mercury website is served by two web servers:
> +	1. The CSSE departmental web server (www.cs.mu.oz.au/research/mercury).
> +	2. The Mercury group web server (www.mercury.cs.mu.oz.au).
> +
> +The departmental web server does not support CGI scripts, but the Mercury
> +group server does.  Therefore any links to CGI scripts should be absolute
> +links to the CGI script on the Mercury group web server.  Use the $www_domain
> +php variable for this purpose.
> +
> +TESTING
> +
> +It is very important to view in a web browser any changes to the website,
> +as php will insert error messages directly into the web pages it generates
> +instead of aborting.
> +
> +To test changes to static HTML pages simply run `make' and open the generated
> +html pages in a web browser.
> +
> +To test changes to CGI scripts, or pages that link to CGI scripts, you need
> +to install the website to a test machine with a web server installed.  The
> +test machine should recognise /cgi-bin as a CGI scripts directory.  At the
> +time of writing this saturn.cs.mu.oz.au was set up as a suitable test

Delete `this'.

> +web server.
> +
> +INSTALLING
s/INSTALLING/INSTALLATION/

> +
You should mention that we have scripts that do this
automatically so these instructions are only necessary if you want
to manually update the website.

> +There are a few things that must be done before running `make install':
> +
> +1. The environment variable INSTALL_WEBDIR must be set to the location where
> +the web pages should be copied to.  Set and export INSTALL_WEBDIR before
> +running `make install', do not run `make install INSTALL_WEBDIR=...' as this
> +will not work.
> +
> +2. The CGI scripts will be installed to /usr/lib/cgi-bin by default, but this
> +can be overridden by setting the CGIBIN_DIR environment variable.
> +
> +3. If you are installing to a machine other that www.mercury.cs.mu.oz.au, then
> +set the WWW_DOMAIN environment variable to the domain of the machine you are
> +installing to (e.g. saturn.cs.mu.oz.au).
> +
> +4.  Before installing checkout the tutorial cvs module with the command
> +`cvs co tutorial'.  It should be checked out to the base directory of your w3
> +workspace.
> +
> +To install type `make install'.

...

> Index: cgi-bin/generate_rotd_page.in
> ===================================================================
> RCS file: cgi-bin/generate_rotd_page.in
> diff -N cgi-bin/generate_rotd_page.in
> --- /dev/null	1 Jan 1970 00:00:00 -0000
> +++ cgi-bin/generate_rotd_page.in	30 Sep 2005 05:41:02 -0000
> @@ -0,0 +1,16 @@
> +#!/bin/sh
> +#-----------------------------------------------------------------------------#
> +# Copyright (C) 1998 University of Melbourne.
> +# This file may only be copied under the terms of the GNU General
> +# Public License - see the file COPYING in the Mercury distribution.
> +#-----------------------------------------------------------------------------#
> +#
> +# This CGI script generates the release of the day download page.
> +# It does this by replacing occurances of the string "<ROTD_VERSION>" in
s/occurances/occurences/

> +# download/rotd.html with the latest release of the day version and outputting
> +# the result.
> +#
> +echo Content-type: text/html
> +echo
> +ROTD=`cat <INSTALL_WEBDIR>/download/files/beta-releases/rotd/latest-unstable-version`
> +sed s/\<ROTD_VERSION\>/$ROTD/ <INSTALL_WEBDIR>/download/rotd.html

...

> Index: download/include/rotd.inc
> ===================================================================
> RCS file: /home/mercury1/repository/w3/download/include/rotd.inc,v
> retrieving revision 1.10
> diff -u -r1.10 rotd.inc
> --- download/include/rotd.inc	8 Sep 2005 09:35:35 -0000	1.10
> +++ download/include/rotd.inc	30 Sep 2005 05:22:03 -0000
> @@ -1,87 +1,179 @@
> -<H2>Release of the Day</H2>
> +<?
>
> -Mercury can have up to four different releases at any given point.
> -<p>
> -Please note that all the currently available versions of Mercury will not work
> -with GCC 4.0 because of a
> -<a href="http://gcc.gnu.org/bugzilla/show_bug.cgi?id=22362">bug</a> in that
> -version of GCC.
> +#
> +# This is PHP3 code.  On Debian systems (e.g. venus.cs.mu.oz.au),

I suggest s/venus/saturn/ there since (1) venus is no longer with us
and (2) when it was last with us it was a Windows machine ;-)

> +# see /usr/share/doc/php3-doc/html/index.html for documentation on PHP3.
> +#
> +
> +$aus_ftp = "ftp://$ftp_domain/pub/mercury/beta-releases/rotd/";
> +$aus_http = "http://$www_domain/download/files/beta-releases/rotd/";
> +
> +function link_to ($directory, $filename, $description)
> +{
> +	echo "<a href = \"" . $directory . $filename .
> +		"\">" . $description . "</a>\n";
> +	echo "   \n";
> +}
> +
> +function links_to_file ($filename)
> +{
> +	global $aus_ftp, $aus_http;
> +
> +	link_to ($aus_ftp, $filename, "Australia (FTP)");
> +	link_to ($aus_http, $filename, "Australia (HTTP)");
> +}

...

>
> +<h3>Supported Platforms</h3>
> +
> +The latest release of the day is known to work on the following platforms:
>
> -<H3> Stable ROTD (release-of-the-day) </H3>
> -<p>
> -To cater for those who need access to the latest cutting edge features
> -of Mercury, but would still like some stability, we release a daily
> -snapshot of the development system.  This is called a "release of the
> -day (ROTD)" and is given a version number "rotd-YYYY-MM-DD" according to
> -the date it was built.
>  <p>
> -<B>Download releases of the day:</b>
> +
>  <ul>
> -<li> <A HREF="<? echo $root; ?>/download/files/beta-releases/rotd/">
> -Mercury web site</A><br>
> -<li> <A HREF="ftp://ftp.mercury.cs.mu.OZ.AU/pub/mercury/beta-releases/rotd/">
> -Mercury ftp site</A>
> +    <li> x86 machines running Debian Linux
x86/x86_64

> +    <li> x86 machines running SuSE Linux
>  </ul>
>
> -<H3> Unstable ROTD </H3>
> +<p>
> +
> +Mercury should also work on the following platforms, although this is not
> +tested for every release of the day.
>
> -For some people, the cutting edge is not enough, and they want the
> -bleeding edge.  To help these developers, we have an <em>unstable</em>
> -release of the day.  This is just like a ROTD, but may not have passed
> -all its tests.  It is marked with a version number
> -"rotd-YYYY-MM-DD-unstable".
>  <p>
> -<B>Download unstable releases of the day:</b>
> +
>  <ul>
> -<li> <A HREF="<? echo $root; ?>/download/files/beta-releases/rotd/">
> -Mercury web site</A><br>
> -<li> <A HREF="ftp://ftp.mercury.cs.mu.OZ.AU/pub/mercury/beta-releases/rotd/">
> -Mercury ftp site</A>
> +    <li> x86 machines running other versions of Microsoft Windows
> +         (95, 98, 98SE, ME, NT, 2000)
> +    <li> x86 machines running other versions of Linux
> +         (however, there are some known problems with the version of GNU C
> +	 that shipped with Red Hat Linux 7.0)

Again, you should mention the x86_64 port here.

> +    <li> x86 machines running FreeBSD 3.0
> +    <li> x86 machines running other BSD Unix systems
> +    <li> x86 machines running SunOS 5.x
> +    <li> x86 machines running Microsoft Windows XP
> +    <li> PowerPC machines running Linux
> +    <li> PowerPC machines running Mac OS 10.3 and above
> +    <li> Sun SPARC machines running SunOS 4.x and 5.x
> +    <li> HP PA machines running HPUX
> +    <li> IBM RS/6000 machines running AIX
> +    <li> DEC Mips machines running ULTRIX
> +    <li> DEC Alpha machines running OSF/1 (Digital Unix)
> +    <li> DEC Alpha machines running Linux
> +    <li> SGI Mips machines running IRIX 5.x
>  </ul>

That looks okay otherwise.

Julien.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------