Including documentation files with gcc releases

Jakub Jelinek jakub@redhat.com
Wed Oct 6 16:05:22 GMT 2021


On Wed, Oct 06, 2021 at 03:57:35PM +0000, dimechc via Gcc wrote:
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
> On Wednesday, October 6th, 2021 at 2:50 PM, Jonathan Wakely <jwakely.gcc@gmail.com> wrote:
> 
> > On Wed, 6 Oct 2021, 14:19 dimechc, <dimechc@protonmail.com> wrote:
> >
> >> I got the GCC 11.2 download, but cannot locate the doc directory used to produce the
> >> gcc documentation manuals.
> >
> > You still haven't said which documentation you're talking about.
> >
> > GCC has lots of documentation. All the sources should be in the release tarball but if you can't tell us which docs you're talking about, we can't point to the specific sources for those docs.
> >
> > It seems you haven't really looked very hard though. You should have grep and find utilities that can help.
> 
> Jakub directed me to gcc/doc/, gcc/*/*.texi, libstdc++-v3/doc/, lib*/*.texi, ...
> 
> I am more used to emacs, and the doc directory is easier to locate as it is a top lever directory.
> 
> The documentation I am referring to is the code provided in
> 
> https://gcc.gnu.org/onlinedocs/11.2.0/
> 
> Do there exist other gcc-related documention files not present in the gcc release? I am looking at gcc-11.2.0.tar.gz (2021-07-28 08:15 137M) ?

The *.texi files which are the sources for most of the documentation are
there, including on git branches.
The *.info files generated from those using the gcc Makefiles are there in
release tarballs, but not on git branches, one needs to build gcc and
when building it it will be generated.
If you mean other formats, that needs other tools to generate them, and
some of them can be created with e.g. make pdf in gcc directory or make html
etc., or there is the maintainer-scripts/update_web_docs_git script that can
generate what is on the web too.
There is also maintainer-scripts/update_web_docs_libstdcxx_git for libstdc++
docs.

	Jakub



More information about the Gcc mailing list