Bug 65699 - online docs lacks version that it documents
Summary: online docs lacks version that it documents
Status: NEW
Alias: None
Product: gcc
Classification: Unclassified
Component: web (show other bugs)
Version: unknown
: P3 enhancement
Target Milestone: ---
Assignee: Not yet assigned to anyone
URL: https://gcc.gnu.org/onlinedocs/gccint/
Keywords: documentation
Depends on:
Blocks:
 
Reported: 2015-04-08 13:05 UTC by Goswin von Brederlow
Modified: 2022-11-15 05:58 UTC (History)
1 user (show)

See Also:
Host:
Target:
Build:
Known to work:
Known to fail:
Last reconfirmed: 2022-11-15 00:00:00


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Goswin von Brederlow 2015-04-08 13:05:05 UTC
The online docs do not mention what version of the compiler they document. When something doesn't work as documented this makes it hard to see if that something is no longer valid in the local version or describes something not yet present in the local version.
Comment 1 Andrew Pinski 2015-04-08 15:37:46 UTC
That link is always the trunk.
Comment 2 Jonathan Wakely 2015-04-08 15:58:46 UTC
(In reply to Goswin von Brederlow from comment #0)
> The online docs do not mention what version of the compiler they document.

The latest one.

> When something doesn't work as documented this makes it hard to see if that
> something is no longer valid in the local version

Impossible, since the online ones are for the latest sources.

> or describes something not
> yet present in the local version.

Adding a version number to the onlinedocs/gccint pages won't change that.

The internals docs for the local version are in the local sources, so use them not the online ones.

I don't see anything that can be usefully done here.
Comment 3 Manuel López-Ibáñez 2015-04-08 17:19:02 UTC
Note that we also store gccint for previous versions:

https://gcc.gnu.org/onlinedocs/gcc-4.9.2/gccint/

but we do not link to them from 

https://gcc.gnu.org/onlinedocs


In addition, perhaps we could simply add:

This file documents the internals of the GNU compilers (GCC version $VERSION).

at the top of the index.html file?
Comment 4 Goswin von Brederlow 2015-04-13 07:41:56 UTC
Yes, a simple statement like that was exactly what I had in mind.
Comment 5 Andrew Pinski 2022-11-10 17:51:14 UTC
This is fixed with the move over to spinx.
Comment 6 Andrew Pinski 2022-11-15 05:41:08 UTC
Sphinx generated manual was reverted for now so reopen this.