GCC documentation: porting to Sphinx
Fri Jun 11 15:50:12 GMT 2021
On Fri, 11 Jun 2021, Martin Liška wrote:
> > Where languages have their own manuals, I think it's more appropriate for
> > those to go under the language-specific directories.
> So it will require the following folder structure:
> $gccroot/gcc/doc/gcc - for GCC documentation
> $gccroot/gcc/doc/gccint - for GCC internal documentation
> $gccroot/gcc/doc/gfortran - for Fortran documentation
> $gccroot/gcc/doc/gccgo - for GO documentation
I'm thinking of
(or subdirectories thereof if desired) for the Fortran and Go manuals, so
they go alongside the front end sources.
> The Sphinx Makefile will be capable of e.g.
My concern with makefiles is what the main GCC build system does, with
"make" run at the top level of the build tree and with the targets defined
by the GNU Coding Standards, not with what happens if someone manually
does make in a subdirectory of the source or build tree.
"make" at top level should build all the info manuals and man pages, as at
present (if a suitable Sphinx version is installed), and "make install"
should install them, in the same directories as at present.
"make html" at top level should build all the HTML manuals, and "make
install-html" should install them.
"make pdf" and "make install-pdf" at top level should work likewise.
"make install-html" and "make install-pdf" should put things under
$(DESTDIR)$(htmldir) and $(DESTDIR)$(pdfdir) as at present.
Joseph S. Myers
More information about the Gcc-patches