diff mbox

[wwwdocs] Consolidate GCC web pages documentation (1/3)

Message ID alpine.LNX.2.00.1308182221530.2133@trevally.site
State New
Headers show

Commit Message

Gerald Pfeifer Aug. 18, 2013, 8:55 p.m. UTC
This is something I wanted to do for ages -- shorten some of the
documentation, and merge three pages into one.  This is the first,
and largest step.

  Streamline about.html a bit and merge (a streamlined version of)
  cvs.html into about.html, removing cvs.html after all those years.

Installed.

Gerald
diff mbox

Patch

Index: about.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/about.html,v
retrieving revision 1.17
diff -u -3 -p -r1.17 about.html
--- about.html	21 Sep 2006 14:17:36 -0000	1.17
+++ about.html	18 Aug 2013 20:28:32 -0000
@@ -10,27 +10,76 @@ 
 
 <p>These pages are maintained by the GCC team, which consists of
 numerous
-<a href="http://gcc.gnu.org/onlinedocs/gcc/Contributors.html">volunteers
-and contributors</a>.</p>
+<a href="http://gcc.gnu.org/onlinedocs/gcc/Contributors.html">
+contributors</a>.</p>
 
-<p>The web effort was originally led by Jeff Law and later Gerald Pfeifer.
-These days, Gerald and Janis Johnson maintain the web pages, but again,
-there are <em>lots</em> of people who contribute.</p>
-
-<p>The pages on gcc.gnu.org are updated "live" (that is, directly after
-a change has been made); www.gnu.org is updated once a day at 4:00 -0700
+<p>The web effort was originally led by Jeff Law.  For the last decade
+or so Gerald Pfeifer has been leading the effort, but again, there are
+<em>lots</em> of people who contribute.</p>
+
+<p>The web pages are under <a href="#cvs">CVS control</a> and you
+can <a href="http://gcc.gnu.org/cgi-bin/cvsweb.cgi/wwwdocs/">browse
+the repository</a> online.
+The pages on gcc.gnu.org are updated "live" (that is, directly after a
+change has been made); www.gnu.org is updated once a day at 4:00 -0700
 (PDT).</p>
 
 <p>Please send feedback, problem reports and patches to our
 <a href="lists.html">mailing lists</a>.
 </p>
 
-<p>The web pages are under <a href="cvs.html">CVS control</a>. Changes
-to the CVS repository immediately propagate to the web server and you
-can easily track any changes or contribute some of your own.
-</p>
-
 <p>Want to contribute? Please check our <a href="projects/web.html">TODO list</a>!</p>
 
+
+
+<hr />
+<h2 id="cvs">Using the CVS repository</h2>
+
+<p>Assuming you have both CVS 
+and SSH installed, you can check out the web pages as follows:</p>
+
+<ol>
+ <li>Set CVS_RSH in your environment to <code>ssh</code>.</li>
+ <li><code>cvs -q -d :ext:<i>username</i>@gcc.gnu.org:/cvs/gcc checkout
+-P wwwdocs</code> where <i>username</i> is your user name at gcc.gnu.org</li>
+</ol>
+
+<p>For anonymous access, use
+<code>-d :pserver:cvs@gcc.gnu.org:/cvs/gcc</code> instead.</p>
+
+
+<h3>Checking in a change</a></h3>
+
+<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>".
+This will also identify any files in your local
+tree that you have modified.</li>
+
+<li>We recommend reviewing the output of "<code>cvs diff</code>".</li>
+
+<li>Use "<code>cvs commit</code>" to check in the patch.</li>
+
+<li>Upon checkin a message will be sent to the gcc-cvs-wwwdocs mailing
+list.</li>
+</ol>
+
+
+<h2 id="system">The host system</h2>
+
+<p>The setup of the machine running the gcc.gnu.org site is also
+available, through
+<a href="http://sourceware.org/cgi-bin/cvsweb.cgi/?cvsroot=sourceware">
+cvsweb</a> and anonymous read-only CVS.  Use the same procedure
+as above, but use
+<code>:pserver:anoncvs@gcc.gnu.org:/cvs/sourceware</code> for the
+repository and <code>infra</code> for the module.</p>
+
+
 </body>
 </html>
Index: cvs.html
===================================================================
RCS file: cvs.html
diff -N cvs.html
--- cvs.html	21 Jun 2012 00:26:32 -0000	1.221
+++ /dev/null	1 Jan 1970 00:00:00 -0000
@@ -1,71 +0,0 @@ 
-<html>
-
-<head>
-<meta name="description" content="Access to the GCC web pages via CVS" />
-<meta name="keywords" content="CVS, version control, GCC, source, public, repository" />
-<title>GCC: CVS access to our web pages</title>
-</head>
-
-<body>
-<h1>GCC: CVS access to our web pages</h1>
-
-<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> or view <a href="projects/web.html">details on the
-setup</a>.</p>
-
-<h2>Using the CVS repository</h2>
-
-<p>Assuming you have both CVS 
-and SSH installed, you can check out the web pages as follows:</p>
-
-<ol>
- <li>Set CVS_RSH in your environment to <code>ssh</code>.</li>
- <li><code>cvs -q -d :ext:<i>username</i>@gcc.gnu.org:/cvs/gcc checkout
--P wwwdocs</code> where <i>username</i> is your user name at gcc.gnu.org</li>
-</ol>
-
-<p>For anonymous access, use
-<code>-d :pserver:cvs@gcc.gnu.org:/cvs/gcc</code> instead.</p>
-
-
-<hr />
-<h2><a name="checkin">Checking in a change</a></h2>
-
-<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 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>".
-This will also identify any files in your local
-tree that you have modified.</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>
-</ol>
-
-<hr />
-<h2><a name="system">The host system</a></h2>
-
-<p>The setup of the machine running the gcc.gnu.org site is also
-available, through
-<a href="http://sourceware.org/cgi-bin/cvsweb.cgi/?cvsroot=sourceware">
-cvsweb</a> and anonymous read-only CVS.  Use the same procedure
-as above, but use
-<code>:pserver:anoncvs@gcc.gnu.org:/cvs/sourceware</code> for the
-repository and <code>infra</code> for the module.</p>
-
-</body>
-</html>