public inbox for gcc-bugs@sourceware.org
help / color / mirror / Atom feed
* [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date
@ 2023-03-31  9:38 jg at jguk dot org
  2023-03-31 11:14 ` [Bug web/109355] " pinskia at gcc dot gnu.org
                   ` (5 more replies)
  0 siblings, 6 replies; 7+ messages in thread
From: jg at jguk dot org @ 2023-03-31  9:38 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

            Bug ID: 109355
           Summary: Add a text warning to old gcc online manual stating it
                    is out of date
           Product: gcc
           Version: 13.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: web
          Assignee: unassigned at gcc dot gnu.org
          Reporter: jg at jguk dot org
  Target Milestone: ---

Could old GCC documentation release HTML web pages have a text warning at the
top making it clear the documentation is out of date?

ie:

"Warning: This GCC manual is not the latest online documentation <link>"

eg searching for "gcc function attributes error" gives me:

https://gcc.gnu.org/onlinedocs/gcc-4.7.2/gcc/Function-Attributes.html

I noticed popular search engines often suggest out of date GCC docs, eg this
one from 2012.

So I manually browse to
https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html

Which is fine, I just find it myself, but it would be nice if there was a
reminder at the top of each page, in case someone doesn't check the URL.

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
@ 2023-03-31 11:14 ` pinskia at gcc dot gnu.org
  2023-03-31 11:15 ` pinskia at gcc dot gnu.org
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: pinskia at gcc dot gnu.org @ 2023-03-31 11:14 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
There is another bug about adding a version to the manual pages. Thar would be
better. Touching old generated html files is not a good solution. Plus the
version is in the url.

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
  2023-03-31 11:14 ` [Bug web/109355] " pinskia at gcc dot gnu.org
@ 2023-03-31 11:15 ` pinskia at gcc dot gnu.org
  2023-03-31 11:30 ` redi at gcc dot gnu.org
                   ` (3 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: pinskia at gcc dot gnu.org @ 2023-03-31 11:15 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

--- Comment #2 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
Oh and the manual is not exactly out of date for that version of gcc. So the
text you have would be wrong.

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
  2023-03-31 11:14 ` [Bug web/109355] " pinskia at gcc dot gnu.org
  2023-03-31 11:15 ` pinskia at gcc dot gnu.org
@ 2023-03-31 11:30 ` redi at gcc dot gnu.org
  2023-03-31 13:00 ` jg at jguk dot org
                   ` (2 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: redi at gcc dot gnu.org @ 2023-03-31 11:30 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

--- Comment #3 from Jonathan Wakely <redi at gcc dot gnu.org> ---
We could add server rules to insert a banner into the HTML on every page, but
it's not trivial.

You might be thinking of PR 65699.

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
                   ` (2 preceding siblings ...)
  2023-03-31 11:30 ` redi at gcc dot gnu.org
@ 2023-03-31 13:00 ` jg at jguk dot org
  2023-03-31 18:02 ` joseph at codesourcery dot com
  2023-03-31 19:59 ` xry111 at gcc dot gnu.org
  5 siblings, 0 replies; 7+ messages in thread
From: jg at jguk dot org @ 2023-03-31 13:00 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

--- Comment #4 from Jonny Grant <jg at jguk dot org> ---
(In reply to Andrew Pinski from comment #2)
> Oh and the manual is not exactly out of date for that version of gcc. So the
> text you have would be wrong.

Sorry, you're completely right.  A script could search for <body> and insert
after:

<h2>Warning: This GCC manual is not the <a
href="https://gcc.gnu.org/onlinedocs/gcc-latest-stable-redirect">latest GCC
release</a></h2>

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
                   ` (3 preceding siblings ...)
  2023-03-31 13:00 ` jg at jguk dot org
@ 2023-03-31 18:02 ` joseph at codesourcery dot com
  2023-03-31 19:59 ` xry111 at gcc dot gnu.org
  5 siblings, 0 replies; 7+ messages in thread
From: joseph at codesourcery dot com @ 2023-03-31 18:02 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

--- Comment #5 from joseph at codesourcery dot com <joseph at codesourcery dot com> ---
As I mentioned in previous discussions of this idea: any implementation 
should *not* involve simply editing the old generated files in place; it 
needs to involve keeping an unmodified copy of those files (which it might 
not readily be possible to regenerate now with current Texinfo) and having 
a properly automated process that goes from the unmodified source to the 
modified version served on the website, with the ability to rerun a new 
version of that process at any time.

^ permalink raw reply	[flat|nested] 7+ messages in thread
* [Bug web/109355] Add a text warning to old gcc online manual stating it is out of date
  2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
                   ` (4 preceding siblings ...)
  2023-03-31 18:02 ` joseph at codesourcery dot com
@ 2023-03-31 19:59 ` xry111 at gcc dot gnu.org
  5 siblings, 0 replies; 7+ messages in thread
From: xry111 at gcc dot gnu.org @ 2023-03-31 19:59 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109355

Xi Ruoyao <xry111 at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |xry111 at gcc dot gnu.org

--- Comment #6 from Xi Ruoyao <xry111 at gcc dot gnu.org> ---
(In reply to Jonny Grant from comment #4)
> (In reply to Andrew Pinski from comment #2)
> > Oh and the manual is not exactly out of date for that version of gcc. So the
> > text you have would be wrong.
> 
> Sorry, you're completely right.  A script could search for <body> and insert
> after:
> 
> <h2>Warning: This GCC manual is not the <a
> href="https://gcc.gnu.org/onlinedocs/gcc-latest-stable-redirect">latest GCC
> release</a></h2>

It would be wrong.  GCC 9.5 released after GCC 12.1, so GCC 12.1 was not the
"latest" GCC release on May 27, 2022.  But we absolutely didn't want people to
look at GCC 9.5 doc instead of 12.1.

^ permalink raw reply	[flat|nested] 7+ messages in thread
end of thread, other threads:[~2023-03-31 19:59 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-31  9:38 [Bug web/109355] New: Add a text warning to old gcc online manual stating it is out of date jg at jguk dot org
2023-03-31 11:14 ` [Bug web/109355] " pinskia at gcc dot gnu.org
2023-03-31 11:15 ` pinskia at gcc dot gnu.org
2023-03-31 11:30 ` redi at gcc dot gnu.org
2023-03-31 13:00 ` jg at jguk dot org
2023-03-31 18:02 ` joseph at codesourcery dot com
2023-03-31 19:59 ` xry111 at gcc dot gnu.org

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).