https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107634
Bug ID: 107634
Summary: Very long filenames and URLs for sphinx-based docs
Product: gcc
Version: 13.0
Status: UNCONFIRMED
Keywords: documentation
Severity: normal
Priority: P3
Component: other
Assignee: unassigned at gcc dot gnu.org
Reporter: dmalcolm at gcc dot gnu.org
CC: marxin at gcc dot gnu.org
Target Milestone: ---
Although mostly I'm very happy with how our docs look after migration to
sphinx, the new filenames (and thus URLs) for the sphinx-based docs seem overly
long.
I just added a new option to -fanalyzer. Previously I had to edit:
gcc/doc/invoke.texi
and the generated HTML would be in:
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/Static-Analyzer-Options.html
Now I have to edit:
gcc/doc/gcc/gcc-command-options/options-that-control-static-analysis.rst
and the generated HTML is in:
https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/options-that-control-static-analysis.html
which repeats "gcc" and "options". Some of them are:
options-that-*
and others are:
options-for-*
and:
options-to-*
and:
options-controlling-*
Perhaps this is just unfamiliarity with the new system, but it seems like the
filenames could be much shorter, so e.g. rather than:
gcc/doc/gcc/gcc-command-options/options-that-control-static-analysis.rst
we could have:
gcc/doc/gcc/options/analyzer.rst
or somesuch.
Similar, we have:
gcc/doc/gcc/gcc-command-options/machine-dependent-options/aarch64-options.rst
https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/machine-dependent-options/aarch64-options.html
which has "options" 3 times; perhaps it could be:
gcc/doc/gcc/options/target/aarch64.rst
or somesuch.
...and yet another set of redirects for the HTML, I guess :-/
