Re: [RFC] docs: remove documentation for unsupported releases
On Thu, 10 Nov 2022, Martin Liška wrote: > On 11/10/22 08:29, Gerald Pfeifer wrote: > > On Wed, 9 Nov 2022, Alexander Monakov wrote: > >> For this I would suggest using the tag to neatly fold links > >> for old releases. Please see the attached patch. > > > > Loving it, Alexander! > > > > What do you guys think about unfolding all releases we, the GCC project, > > currently support (per https://gcc.gnu.org that'd be 12.x, 11.x, and 10.x > > at this point)? > > Works for me! > > > > > Either way: yes, please (aka approved). :-) > > Alexander, can you please install such change? Yes, pushed: https://gcc.gnu.org/onlinedocs/ Alexander
Re: [RFC] docs: remove documentation for unsupported releases
On 11/10/22 08:29, Gerald Pfeifer wrote: On Wed, 9 Nov 2022, Alexander Monakov wrote: For this I would suggest using the tag to neatly fold links for old releases. Please see the attached patch. Loving it, Alexander! What do you guys think about unfolding all releases we, the GCC project, currently support (per https://gcc.gnu.org that'd be 12.x, 11.x, and 10.x at this point)? Works for me! Either way: yes, please (aka approved). :-) Alexander, can you please install such change? Thanks, Martin On Wed, 9 Nov 2022, Martin Liška wrote: I do support the patch. It should help with the Google indexing (maybe). And thank you for raising this, Martin! Gerald
Re: [RFC] docs: remove documentation for unsupported releases
On Wed, 9 Nov 2022, Alexander Monakov wrote: > For this I would suggest using the tag to neatly fold links > for old releases. Please see the attached patch. Loving it, Alexander! What do you guys think about unfolding all releases we, the GCC project, currently support (per https://gcc.gnu.org that'd be 12.x, 11.x, and 10.x at this point)? Either way: yes, please (aka approved). :-) On Wed, 9 Nov 2022, Martin Liška wrote: > I do support the patch. It should help with the Google indexing (maybe). And thank you for raising this, Martin! Gerald
Re: [RFC] docs: remove documentation for unsupported releases
On 11/9/22 20:32, Alexander Monakov wrote: > > On Wed, 9 Nov 2022, Martin Liška wrote: > >> Hi. >> >> I think we should remove documentation for unsupported GCC releases >> as it's indexed by Google engine. > > I'd agree with previous responses that outright removing the links is > undesirable, and pointing Google to recent documentation should be done > by annotating links, e.g. via rel=canonical as indicated by Joseph. > > I would add that adding rel=canonical links seems doable without modifying > old files, by configuring the web server to add HTTP Link: header. > >> Second reason is that the page is long >> one one can't easily jump to Current development documentation. > > For this I would suggest using the tag to neatly fold links for > old releases. Please see the attached patch. I do support the patch. It should help with the Google indexing (maybe). Martin > > Alexander
Re: [RFC] docs: remove documentation for unsupported releases
On Wed, 9 Nov 2022, Martin Liška wrote: > Hi. > > I think we should remove documentation for unsupported GCC releases > as it's indexed by Google engine. I'd agree with previous responses that outright removing the links is undesirable, and pointing Google to recent documentation should be done by annotating links, e.g. via rel=canonical as indicated by Joseph. I would add that adding rel=canonical links seems doable without modifying old files, by configuring the web server to add HTTP Link: header. > Second reason is that the page is long > one one can't easily jump to Current development documentation. For this I would suggest using the tag to neatly fold links for old releases. Please see the attached patch. AlexanderFrom ab6ce8c24aa17dba8ed79f3c3f7a5e8038dd3205 Mon Sep 17 00:00:00 2001 From: Alexander Monakov Date: Wed, 9 Nov 2022 22:17:16 +0300 Subject: [PATCH] Fold doc links for old releases using tag --- htdocs/onlinedocs/index.html | 151 ++- 1 file changed, 96 insertions(+), 55 deletions(-) diff --git a/htdocs/onlinedocs/index.html b/htdocs/onlinedocs/index.html index 3410f731..03cbdbeb 100644 --- a/htdocs/onlinedocs/index.html +++ b/htdocs/onlinedocs/index.html @@ -18,8 +18,8 @@ caring about internals should really be using the mainline versions. --> - - GCC 12.2 manuals: + + GCC 12.2 manuals: https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/";>GCC 12.2 Manual ( https://gcc.gnu.org/onlinedocs/gcc-12.2.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 12.2 manuals - + + - GCC 11.3 manuals: + + GCC 11.3 manuals: https://gcc.gnu.org/onlinedocs/gcc-11.3.0/gcc/";>GCC 11.3 Manual ( https://gcc.gnu.org/onlinedocs/gcc-11.3.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 11.3 manuals - + + - GCC 10.4 manuals: + + GCC 10.4 manuals: https://gcc.gnu.org/onlinedocs/gcc-10.4.0/gcc/";>GCC 10.4 Manual ( https://gcc.gnu.org/onlinedocs/gcc-10.4.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 10.4 manuals - + + - GCC 9.5 manuals: + + GCC 9.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc/";>GCC 9.5 Manual ( https://gcc.gnu.org/onlinedocs/gcc-9.5.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 9.5 manuals - + + - GCC 8.5 manuals: + + GCC 8.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-8.5.0/gcc/";>GCC 8.5 Manual ( https://gcc.gnu.org/onlinedocs/gcc-8.5.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 8.5 manuals - + + - GCC 7.5 manuals: + + GCC 7.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-7.5.0/gcc/";>GCC 7.5 Manual ( https://gcc.gnu.org/onlinedocs/gcc-7.5.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 7.5 manuals - + + - GCC 6.5 manuals: + + GCC 6.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-6.5.0/gcc/";>GCC 6.5 Manual ( https://gcc.gnu.org/onlinedocs/gcc-6.5.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 6.5 manuals - + + - GCC 5.5 manuals: + + GCC 5.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-5.5.0/gcc/";>GCC 5.5 Manual ( https://gcc.gnu.org/onlinedocs/gcc-5.5.0/docs-sources.tar.gz";>Texinfo sources of all the GCC 5.5 manuals - + + - GCC 4.9.4 manuals: + + GCC 4.9.4 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.9.4/gcc/";>GCC 4.9.4 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.9.4/docs-sources.tar.gz";>Texinfo sources of all the GCC 4.9.4 manuals - + + - GCC 4.8.5 manuals: + + GCC 4.8.5 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.8.5/gcc/";>GCC 4.8.5 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.8.5/docs-sources.tar.gz";>Texinfo sources of all the GCC 4.8.5 manuals - - + + - GCC 4.7.4 manuals: + + GCC 4.7.4 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.7.4/gcc/";>GCC 4.7.4 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.7.4/docs-sources.tar.gz";>Texinfo sources of all the GCC 4.7.4 manuals - - + + - GCC 4.6.4 manuals: + + GCC 4.6.4 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.6.4/gcc/";>GCC 4.6.4 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.6.4/docs-sources.tar.gz";>Texinfo sources of all the GCC 4.6.4 manuals - - + + - GCC 4.5.4 manuals: + + GCC 4.5.4 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.5.4/gcc/";>GCC 4.5.4 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.5.4/docs-sources.tar.gz";>Texinfo sources of all the GCC 4.5.4 manuals - - + + - GCC 4.4.7 manuals: + + GCC 4.4.7 manuals: https://gcc.gnu.org/onlinedocs/gcc-4.4.7/gcc/";>GCC 4.4.7 Manual () https://gcc.gnu.org/onlinedocs/gcc-4.4.7/docs-sources.tar.gz";>Texinfo
Re: [RFC] docs: remove documentation for unsupported releases
On Wed, 9 Nov 2022, Michael Matz via Gcc-patches wrote: > I think everything that's on the web server (even the 2.95 docu) has to be > reachable via a (reasonable) set of clicks from the main index.html. It > doesn't need to be _directly_ from the main index.html, though. > > Also, you simply might want to move the "Current Development" section > to the front if it's currently too cumbersome to reach. > > (E.g. one could move the index of the obsolete versions to a different web > page, make that one un-indexable by google, but leave a trace to that one > from the main index.html). Although we could use robots.txt to prevent indexing of the old documentation, that's not quite right, in that there's no problem with robots accessing the old documentation for any purpose (indexing, archiving, downloading a local copy of all the docs for an old version, etc.), just with showing it in a search engine in preference to a more recent version. The logically correct way of directing search engines to the preferred version to index is . Suppose we could develop some reasonably reliable way of making automated substitutions in the HTML manuals for old versions. (Make sure the original versions of the files, generated years ago, are backed up first! Indeed, when we want to revise such substitutions, we should go back to the original versions of the files to do so rather than piling one substitution on top of another - i.e. the original versions should be kept somewhere readily available for that purpose, just not directly in the web area.) Then we could substitute such to point to a more recent release (that has a matching documentation page). And as I mentioned at the Cauldron, I think having human-visible notices on the pages for old versions, linking to the corresponding page for human readers - like there are in old versions of the Python documentation - would be a good idea as well. Maybe it would be hard to find matching pages in an automated way across the Sphinx transition - so all EOL versions before GCC 12 would end up pointing to corresponding pages in GCC 12 documentation and a more general index for later versions, rather than a corresponding page for a later version - but whatever can be done automatically in terms of rel="canonical" for search engines and a prominent notice at the top of each page for human readers still seems like it would be a significant improvement (and something that could be improved further incrementally). -- Joseph S. Myers jos...@codesourcery.com
Re: [RFC] docs: remove documentation for unsupported releases
Hello, On Wed, 9 Nov 2022, Martin Liška wrote: > I think we should remove documentation for unsupported GCC releases > as it's indexed by Google engine. Second reason is that the page is long > one one can't easily jump to Current development documentation. > > Thoughts? I think everything that's on the web server (even the 2.95 docu) has to be reachable via a (reasonable) set of clicks from the main index.html. It doesn't need to be _directly_ from the main index.html, though. Also, you simply might want to move the "Current Development" section to the front if it's currently too cumbersome to reach. (E.g. one could move the index of the obsolete versions to a different web page, make that one un-indexable by google, but leave a trace to that one from the main index.html). Ciao, Michael. > Martin > > --- > htdocs/onlinedocs/index.html | 1294 -- > 1 file changed, 1294 deletions(-) > > diff --git a/htdocs/onlinedocs/index.html b/htdocs/onlinedocs/index.html > index cfa8bf5a..138dde95 100644 > --- a/htdocs/onlinedocs/index.html > +++ b/htdocs/onlinedocs/index.html > @@ -255,1300 +255,6 @@ > href="https://gcc.gnu.org/onlinedocs/gcc-10.4.0/docs-sources.tar.gz";>Texinfo > sources of all the GCC 10.4 manuals > > - > - GCC 9.5 manuals: > - > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc/";>GCC > - 9.5 Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc.ps.gz";>PostScript or - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran/";>GCC > - 9.5 GNU Fortran Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp/";>GCC > - 9.5 CPP Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp.ps.gz";>PostScript or - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm/";>GCC > - 9.5 GNAT Reference Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn/";>GCC > - 9.5 GNAT User's Guide ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn-html.tar.gz";>an > - HTML tarball) > - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++/manual/";>GCC > - 9.5 Standard C++ Library Manual ( - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual.pdf.gz";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual.xml.gz";>XML > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++/api/";>GCC > - 9.5 Standard C++ Library Reference Manual ( - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api.pdf.gz";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api.xml.gz";>XML > GPL or > - - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api-gfdl.xml.gz";>XML > GFDL or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo/";>GCCGO 9.5 > Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo.pdf";>also in > - PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo.ps.gz";>PostScript or > - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libgomp/";>GCC 9.5 > - GNU Offloading and Multi Processing Runtime Library Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libgomp.pdf";>also in > - PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/li
Re: [RFC] docs: remove documentation for unsupported releases
On Wed, Nov 09, 2022 at 02:54:48PM +0100, Martin Liška wrote: > I think we should remove documentation for unsupported GCC releases > as it's indexed by Google engine. Second reason is that the page is long > one one can't easily jump to Current development documentation. > > Thoughts? I'd prefer to move it into a separate old.html or unsupported.html and perhaps mark it so that search engines ignore it. With a link from onlinedocs/index.html to that. While we don't support those releases, they are actually used in the wild, both through vendor support or just because people keep using them unsupported. In either case, branch-closing.html should be updated to include the required manual step (either drop the old release from onlinedocs/index.html, or move it to the other page). Dropping the docs altogether would mean it wouldn't make much sense to even generate documentation for the last release from a release branch, because those by definition go immediately out of support. We still release them... > diff --git a/htdocs/onlinedocs/index.html b/htdocs/onlinedocs/index.html > index cfa8bf5a..138dde95 100644 > --- a/htdocs/onlinedocs/index.html > +++ b/htdocs/onlinedocs/index.html > @@ -255,1300 +255,6 @@ > href="https://gcc.gnu.org/onlinedocs/gcc-10.4.0/docs-sources.tar.gz";>Texinfo > sources of all the GCC 10.4 manuals > > - > - GCC 9.5 manuals: > - > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc/";>GCC > - 9.5 Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc.ps.gz";>PostScript or - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gcc-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran/";>GCC > - 9.5 GNU Fortran Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gfortran-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp/";>GCC > - 9.5 CPP Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp.ps.gz";>PostScript or - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/cpp-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm/";>GCC > - 9.5 GNAT Reference Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_rm-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn/";>GCC > - 9.5 GNAT User's Guide ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn.pdf";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn.ps.gz";>PostScript > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gnat_ugn-html.tar.gz";>an > - HTML tarball) > - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++/manual/";>GCC > - 9.5 Standard C++ Library Manual ( - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual.pdf.gz";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual.xml.gz";>XML > or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-manual-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++/api/";>GCC > - 9.5 Standard C++ Library Reference Manual ( - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api.pdf.gz";>also > - in PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api.xml.gz";>XML > GPL or > - - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api-gfdl.xml.gz";>XML > GFDL or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libstdc++-api-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo/";>GCCGO 9.5 > Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo.pdf";>also in > - PDF or - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo.ps.gz";>PostScript or > - > href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/gccgo-html.tar.gz";>an > - HTML tarball) > -https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libgomp/";>GCC 9.5 > - GNU Offloading and Multi Processing Runtime Library Manual ( - href="https://gcc.gnu.org/onlinedocs/gcc-9.5.0/libgomp.pdf";>also in > -