From patchwork Thu Jun 21 00:27:35 2012
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Gerald Pfeifer
X-Patchwork-Id: 166172
Return-Path:
X-Original-To: incoming@patchwork.ozlabs.org
Delivered-To: patchwork-incoming@bilbo.ozlabs.org
Received: from sourceware.org (server1.sourceware.org [209.132.180.131])
by ozlabs.org (Postfix) with SMTP id 66276B6FB9
for ;
Thu, 21 Jun 2012 10:28:02 +1000 (EST)
Comment: DKIM? See http://www.dkim.org
DKIM-Signature: v=1; a=rsa-sha1; c=relaxed/relaxed;
d=gcc.gnu.org; s=default; x=1340843282; h=Comment:
DomainKey-Signature:Received:Received:Received:Received:Date:
From:To:cc:Subject:In-Reply-To:Message-ID:References:
MIME-Version:Content-Type:Mailing-List:Precedence:List-Id:
List-Unsubscribe:List-Archive:List-Post:List-Help:Sender:
Delivered-To; bh=Fj5lemp/QHnUQponQ0DnfyyykZA=; b=gx5S1jPdfHHWmvo
RPBKAC+YC6QzwxTXXv7neuXCnNyGuYV5f2GE1Suo+9fQKvKtk9tfzAFpcu5EZoEI
rqN+8W2j8e9mXd6LjnzEuZ4TH8b9SKr3MK5najEEh4MjrbLvUuXJdn5XZ/p1Rkhl
6YHYF9BGCjrF6gdFMjM2aVuw4Cs4=
Comment: DomainKeys? See http://antispam.yahoo.com/domainkeys
DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=default; d=gcc.gnu.org;
h=Received:Received:X-SWARE-Spam-Status:X-Spam-Check-By:Received:Received:Date:From:To:cc:Subject:In-Reply-To:Message-ID:References:MIME-Version:Content-Type:X-IsSubscribed:Mailing-List:Precedence:List-Id:List-Unsubscribe:List-Archive:List-Post:List-Help:Sender:Delivered-To;
b=RkhiEJnHf9pPMAJ+xQMiJqfgzI4vZ9hFjhVYs0R2c1xoEv+FsijfVFhhyByPjZ
APFkCZTFB6tyBhPpnuv6N7fLRGVRnsGcnUczTW0E16CdXnb1gTa+fguHTi3wyMsi
zWH/rpd47PkuDveAYA5RK8Ig2/18hkQtsbdFc/xdT+Ye4=;
Received: (qmail 31351 invoked by alias); 21 Jun 2012 00:27:58 -0000
Received: (qmail 31227 invoked by uid 22791); 21 Jun 2012 00:27:55 -0000
X-SWARE-Spam-Status: No, hits=-2.4 required=5.0 tests=AWL, BAYES_00,
HK_OBFDOM, KHOP_THREADED, TW_WW
X-Spam-Check-By: sourceware.org
Received: from ainaz.pair.com (HELO ainaz.pair.com) (209.68.2.66) by
sourceware.org (qpsmtpd/0.43rc1) with ESMTP;
Thu, 21 Jun 2012 00:27:40 +0000
Received: from ip-109-85-126-244.web.vodafone.de
(ip-109-85-126-244.web.vodafone.de [109.85.126.244]) by
ainaz.pair.com (Postfix) with ESMTPSA id 277BD3F445;
Wed, 20 Jun 2012 20:27:37 -0400 (EDT)
Date: Thu, 21 Jun 2012 02:27:35 +0200 (CEST)
From: Gerald Pfeifer
To: Lawrence Crowl
cc: gcc-patches List
Subject: Re: [wwwdocs] Make codingconventions.html pass W3 validator.
In-Reply-To:
Message-ID:
References:
MIME-Version: 1.0
X-IsSubscribed: yes
Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm
Precedence: bulk
List-Id:
List-Unsubscribe:
List-Archive:
List-Post:
List-Help:
Sender: gcc-patches-owner@gcc.gnu.org
Delivered-To: mailing list gcc-patches@gcc.gnu.org
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 @@
GCC: Web Pages
+Contributing changes to
+our web pages is simple.
+
Our web pages are managed via CVS and can be accessed using the
directions for our CVS setup.
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 is simple.
Our web pages are managed via CVS and can be accessed using the
directions for our CVS setup.
+As changes are checked in, the respective pages are preprocessed
+via the script wwwdocs/bin/preprocess
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
+wwwdocs/htdocs/style.mhtml
.
+
TODO
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 @@
Our web pages and related scripts are available via our CVS
repository. You can also browse them
-online.
+online or view details on the
+setup.
Using the CVS repository
@@ -28,8 +29,6 @@ and SSH installed, you can check out the
For anonymous access, use
-d :pserver:cvs@gcc.gnu.org:/cvs/gcc
instead.
-Patches should be marked with the tag [wwwdocs] in the subject line.
-
@@ -37,25 +36,21 @@ and SSH installed, you can check out the
When you check in changes to our web pages, they will
automatically be checked out into the web server's data area.
-The following is meant to provide a very quick overview of how
+
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.
- Sync your sources with the master repository via "
cvs
-update
" 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".
+This will also identify any files in your local
tree that you have modified.
-- We recommend using "
cvs diff
" 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.
-
-- Use "
cvs commit
" to check in the patch. You can enter
-the log message via the "-m
" argument to commit, or wait for
-the editor window to appear.
+- We recommend reviewing the output of "
cvs diff
" after
+applying a patch to a local tree.
+
+- Use "
cvs commit
" to check in the patch.
- Upon successfull checkin a message will be sent to the
gcc-cvs-wwwdocs mailing list.