Generating GCC Documentation

[Jonathan Wakely]

On Wed, 10 Nov 2021 at 14:08, Joel Sherrill wrote:
>
> Hi
>
> It's been a while since I tried this and it appears things have
> changed. I tried to follow the instructions at:
>
> https://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_hacking.html

Are you asking about docs for GCC itself, or libstdc++? Those docs are
for the latter only.

> with gcc 11.2 and had a few questions:
>
> + I did a simple configure --prefix=/tmp/gcc-docs the first time and
> then "make html". One of those told me prerequisites were missing so I
> downloaded them and then it proceeded to build the compiler before
> building the html. Is that expected? Can you build the docs without
> building the compiler itself?

For libstdc++? Yes, see maintainer-scripts/generate_libstdcxx_web_docs

For GCC itself, I am not sure, but
maintainer-scripts/update_web_docs_git might help.


>
> + I was going through the formats in the order on the document. I
> sucessfully built html and pdf. But make man from the top of the build
> directory doesn't work.
>
>  make man
> make: *** No rule to make target `man'.  Stop.

You seem to be trying to follow the libstdc++ docs in the top-level,
that's not going to work.

>
> "make -C gcc install-man" does install some man pages so I'm guessing
> something is wrong with the top Makefile.

I think you're following the wrong docs.

At the top-level, 'make -C gcc doc' works, and so does 'make -C gcc html'

If you really do want to build the libstdc++ docs, you need to be in
the $target/libstdc++-v3/ sub-directory to use the libstdc++ makefile
targets.