Lawrence, you ask a number of awfully good questions. :-)
First of all you made me realize that we were missing a cross-link from http://gcc.gnu.org/projects/web.html to http://gcc.gnu.org/contribute.html#webchanges which the first patch included below does now. On Tue, 5 Jun 2012, Lawrence Crowl wrote: > Where do these prepended pages come from? How do I test the page > as it will appear? This is covered in http://gcc.gnu.org/contribute.html#webchanges . > I guess maybe I'm asking for the makefile that produces what one > would see. I want to validate that. This is now documented via the second patch below. > BTW, part of the problem is that the pages are complete enough as > they are to be considered complete. I.e. they are not obviously > fragments. Would it be better to make them clearly fragments? The idea was for them to be basic HTML, so that people can view them in their browsers and use some clever editors without problems. So far this has generally worked well. Is there something we can tweak to make it better for you? > Doesn't the prepending prevent incremental migration to new > standards? This is true, though we can mitigate this by adding separate tags or annotations to either "old" or "new" pages during such a transition. The last time I did such a transition, it was not a big issue, though, and I expect web standards to be more incremental and usually quite compatible. But, you are right. >> Since you ran into this, I would like to document this better. >> Would http://gcc.gnu.org/projects/web.html be a good place, >> or do you have a different suggestion? > My entry point was http://gcc.gnu.org/cvs.html, so at a minimum it > need to be cross linked with http://gcc.gnu.org/projects/web.html. Done via the patch below, which also shortens the cvs.html page to make it easier to consume (and move/integrate somewhere else later on). Anything else I can answer / document, let me know! Gerald Index: projects/web.html =================================================================== RCS file: /cvs/gcc/wwwdocs/htdocs/projects/web.html,v retrieving revision 1.11 diff -u -3 -p -r1.11 web.html --- projects/web.html 30 Mar 2008 18:59:30 -0000 1.11 +++ projects/web.html 20 Jun 2012 23:50:38 -0000 @@ -8,6 +8,9 @@ <h1>GCC: Web Pages</h1> +<p><a href="../contribute.html#webchanges">Contributing changes to +our web pages</a> is simple.</p> + <p>Our web pages are managed via CVS and can be accessed using the directions for <a href="../cvs.html">our CVS setup</a>.</p> Index: projects/web.html =================================================================== RCS file: /cvs/gcc/wwwdocs/htdocs/projects/web.html,v retrieving revision 1.12 diff -u -3 -p -r1.12 web.html --- projects/web.html 20 Jun 2012 23:55:35 -0000 1.12 +++ projects/web.html 21 Jun 2012 00:02:02 -0000 @@ -14,6 +14,13 @@ our web pages</a> is simple.</p> <p>Our web pages are managed via CVS and can be accessed using the directions for <a href="../cvs.html">our CVS setup</a>.</p> +<p>As changes are checked in, the respective pages are preprocessed +via the script <code>wwwdocs/bin/preprocess</code> which in turn +uses a tool called MetaHTML. Among others, this preprocessing +adds CSS style sheets, XML and HTML headers, and our standard +footer. The MetaHTML style sheet is in +<code>wwwdocs/htdocs/style.mhtml</code>.</p> + <h2>TODO</h2> <p>Any help concerning open issues is highly welcome, as are Index: cvs.html =================================================================== RCS file: /cvs/gcc/wwwdocs/htdocs/cvs.html,v retrieving revision 1.220 diff -u -3 -p -r1.220 cvs.html --- cvs.html 3 Apr 2011 13:00:43 -0000 1.220 +++ cvs.html 21 Jun 2012 00:25:42 -0000 @@ -12,7 +12,8 @@ <p>Our web pages and related scripts are available via our CVS repository. You can also <a href="http://gcc.gnu.org/cgi-bin/cvsweb.cgi/wwwdocs/";>browse them -online</a>.</p> +online</a> or view <a href="projects/web.html">details on the +setup</a>.</p> <h2>Using the CVS repository</h2> @@ -28,8 +29,6 @@ and SSH installed, you can check out the <p>For anonymous access, use <code>-d :pserver:c...@gcc.gnu.org:/cvs/gcc</code> instead.</p> -<p>Patches should be marked with the tag [wwwdocs] in the subject line.</p> - <hr /> <h2><a name="checkin">Checking in a change</a></h2> @@ -37,25 +36,21 @@ and SSH installed, you can check out the <p>When you check in changes to our web pages, they will automatically be checked out into the web server's data area.</p> -<p>The following is meant to provide a very quick overview of how +<p>The following is a very quick overview of how to check in a change. We recommend you list files explicitly to avoid accidental checkins and prefer that each checkin be of a complete, single logical change.</p> <ol> <li>Sync your sources with the master repository via "<code>cvs -update</code>" before attempting a checkin; this will save you a little -time if someone else has modified that file since the last time you -synced your sources. It will also identify any files in your local +update</code>". +This will also identify any files in your local tree that you have modified.</li> -<li>We recommend using "<code>cvs diff</code>" after applying a patch to a -local tree. Review the output to make sure that only the changes you -wanted to check in will be checked in.</li> - -<li>Use "<code>cvs commit</code>" to check in the patch. You can enter -the log message via the "<code>-m</code>" argument to commit, or wait for -the editor window to appear.</li> +<li>We recommend reviewing the output of "<code>cvs diff</code>" after +applying a patch to a local tree.</li> + +<li>Use "<code>cvs commit</code>" to check in the patch.</li> <li>Upon successfull checkin a message will be sent to the gcc-cvs-wwwdocs mailing list.</li>
