diff mbox series

wwwdocs: Do not rewrite the page titles

Message ID YHy2jE3ouoawrgN2@redhat.com
State New
Headers show
Series wwwdocs: Do not rewrite the page titles | expand

Commit Message

Jonathan Wakely April 18, 2021, 10:45 p.m. UTC
Remove GNU and FSF attribution from HTML page titles.


I don't see why we should have to "comply with the GNU style" if we're
truly an independent project run by the GCC developers and aided by
the steering committee.

OK for wwwdocs?
commit d157082f49725510560cb83f2f1c045e2968ad3b
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Sun Apr 18 23:42:26 2021 +0100

    Do not rewrite the page titles
    
    Remove GNU and FSF attribution from HTML page titles.

Comments

Richard Kenner April 19, 2021, 4:33 p.m. UTC | #1
> I don't see why we should have to "comply with the GNU style" if we're
> truly an independent project run by the GCC developers and aided by
> the steering committee.

I think it critical than any code have *some* style guidelines.  If you
don't like the GNU coding convention, which do you propose instead and
how do you propose to convert the existing code to that style?
Jonathan Wakely April 19, 2021, 7:55 p.m. UTC | #2
On 19/04/21 12:33 -0400, Richard Kenner wrote:
>> I don't see why we should have to "comply with the GNU style" if we're
>> truly an independent project run by the GCC developers and aided by
>> the steering committee.
>
>I think it critical than any code have *some* style guidelines.  If you
>don't like the GNU coding convention, which do you propose instead and
>how do you propose to convert the existing code to that style?

I'm not suggesting any changes to coding conventions. As you say, some
style is needed, and the current one is fine and it would be pointless
churn to change it.

The patch is for the website stylesheet, and simply removes the rule
that rewrites the HTML <title> element to "comply with the GNU style".
If that rule is removed then the page titles will be simply the
original content of the <title> element as it appears in the HTML
source, without rewriting e.g.
https://gcc.gnu.org/git/?p=gcc-wwwdocs.git;a=blob;f=htdocs/index.html;h=5598df7851048f510b4a70744a1d4c9861157c19;hb=HEAD#l7
Jonathan Wakely April 19, 2021, 8:14 p.m. UTC | #3
On 19/04/21 20:55 +0100, Jonathan Wakely wrote:
>On 19/04/21 12:33 -0400, Richard Kenner wrote:
>>>I don't see why we should have to "comply with the GNU style" if we're
>>>truly an independent project run by the GCC developers and aided by
>>>the steering committee.
>>
>>I think it critical than any code have *some* style guidelines.  If you
>>don't like the GNU coding convention, which do you propose instead and
>>how do you propose to convert the existing code to that style?
>
>I'm not suggesting any changes to coding conventions. As you say, some
>style is needed, and the current one is fine and it would be pointless
>churn to change it.
>
>The patch is for the website stylesheet, and simply removes the rule
>that rewrites the HTML <title> element to "comply with the GNU style".
>If that rule is removed then the page titles will be simply the
>original content of the <title> element as it appears in the HTML
>source, without rewriting e.g.
>https://gcc.gnu.org/git/?p=gcc-wwwdocs.git;a=blob;f=htdocs/index.html;h=5598df7851048f510b4a70744a1d4c9861157c19;hb=HEAD#l7

The relevant style guideline is the last bullet at:
https://www.gnu.org/server/standards/gnu-website-guidelines.en.html#html-required

But it's only a "should", and I note that these other GNU projects do
not do it:

https://www.gnu.org/software/gdb/
https://www.gnu.org/software/libc/
https://www.gnu.org/software/guile/
https://www.gnu.org/software/emacs/
https://www.gnu.org/software/guix/

Of the ones I checked, only GCC and Binutils do it.

Since GCC isn't on GNU or FSF hardware and isn't supported financially
by the FSF, and operates independently since the EGCS merger, I don't
see why GCC needs to rewrite the page titles.
Jonathan Wakely June 3, 2021, 3:50 p.m. UTC | #4
Ping.

Is this OK now?


On 18/04/21 23:45 +0100, Jonathan Wakely wrote:
>Remove GNU and FSF attribution from HTML page titles.
>
>
>I don't see why we should have to "comply with the GNU style" if we're
>truly an independent project run by the GCC developers and aided by
>the steering committee.
>
>OK for wwwdocs?
>
>

>commit d157082f49725510560cb83f2f1c045e2968ad3b
>Author: Jonathan Wakely <jwakely@redhat.com>
>Date:   Sun Apr 18 23:42:26 2021 +0100
>
>    Do not rewrite the page titles
>
>    Remove GNU and FSF attribution from HTML page titles.
>
>diff --git a/htdocs/style.mhtml b/htdocs/style.mhtml
>index 677fd05a..eb7c353d 100644
>--- a/htdocs/style.mhtml
>+++ b/htdocs/style.mhtml
>@@ -32,14 +32,6 @@
>  </verbatim>
> </define-container>
>
>-;;; Redefine the <title> tag to comply with the GNU style.
>-
>-<define-container title>
>-<verbatim><title></verbatim>
>-%body
>-<verbatim>- GNU Project - Free Software Foundation (FSF)</title></verbatim>
>-</define-container>
>-
> ;;; Redefine the <body> tag, adding navigation and a standard footer.
>
> <define-container body>
Jonathan Wakely June 3, 2021, 4:04 p.m. UTC | #5
On 03/06/21 16:50 +0100, Jonathan Wakely wrote:
>Ping.
>
>Is this OK now?
>
>
>On 18/04/21 23:45 +0100, Jonathan Wakely wrote:
>>Remove GNU and FSF attribution from HTML page titles.
>>
>>
>>I don't see why we should have to "comply with the GNU style" if we're
>>truly an independent project run by the GCC developers and aided by
>>the steering committee.
>>
>>OK for wwwdocs?

An alternative change would be to just drop the mention of the FSF,
since they don't fund GCC or provide hosting etc., as in the attached
patch.

And as I pointed out previously, none of these sites refer to the FSF
in their page <title>s:

https://www.gnu.org/software/gdb/
https://www.gnu.org/software/libc/
https://www.gnu.org/software/guile/
https://www.gnu.org/software/emacs/
https://guix.gnu.org/

(Some don't refer to the GNU project either.)
Gerald Pfeifer June 15, 2021, 12:19 p.m. UTC | #6
On Thu, 3 Jun 2021, Jonathan Wakely wrote:
> An alternative change would be to just drop the mention of the FSF
:
> And as I pointed out previously, none of these sites refer to the FSF
> in their page <title>s:
> 
> https://www.gnu.org/software/gdb/
> https://www.gnu.org/software/libc/
> https://www.gnu.org/software/guile/
> https://www.gnu.org/software/emacs/
> https://guix.gnu.org/

Yeah, this makes a lot of sense - having such that ultra long page 
titles really isn't helping anyone and the shorter version even is 
more aligned with those other projects.

Okay.

Gerald
Jonathan Wakely July 27, 2021, 3:07 p.m. UTC | #7
I've now pushed this wwwdocs patch, which Gerald approved at
https://gcc.gnu.org/pipermail/gcc-patches/2021-June/572796.html
diff mbox series

Patch

diff --git a/htdocs/style.mhtml b/htdocs/style.mhtml
index 677fd05a..eb7c353d 100644
--- a/htdocs/style.mhtml
+++ b/htdocs/style.mhtml
@@ -32,14 +32,6 @@ 
  </verbatim>
 </define-container>
 
-;;; Redefine the <title> tag to comply with the GNU style.
-
-<define-container title>
-<verbatim><title></verbatim>
-%body
-<verbatim>- GNU Project - Free Software Foundation (FSF)</title></verbatim>
-</define-container>
-
 ;;; Redefine the <body> tag, adding navigation and a standard footer.
 
 <define-container body>