public inbox for gcc-bugs@sourceware.org help / color / mirror / Atom feed
From: "dmalcolm at gcc dot gnu.org" <gcc-bugzilla@gcc.gnu.org> To: gcc-bugs@gcc.gnu.org Subject: [Bug other/107634] New: Very long filenames and URLs for sphinx-based docs Date: Fri, 11 Nov 2022 13:27:07 +0000 [thread overview] Message-ID: <bug-107634-4@http.gcc.gnu.org/bugzilla/> (raw) 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 :-/
next reply other threads:[~2022-11-11 13:27 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-11-11 13:27 dmalcolm at gcc dot gnu.org [this message] 2022-11-11 13:36 ` [Bug other/107634] " rguenth at gcc dot gnu.org 2022-11-11 15:49 ` pinskia at gcc dot gnu.org 2022-11-11 16:57 ` ebotcazou at gcc dot gnu.org 2022-11-11 16:58 ` ebotcazou at gcc dot gnu.org 2022-11-11 23:49 ` pinskia at gcc dot gnu.org 2022-11-11 23:53 ` pinskia at gcc dot gnu.org 2022-11-12 8:11 ` ebotcazou at gcc dot gnu.org 2022-11-13 18:17 ` marxin at gcc dot gnu.org 2022-11-13 18:30 ` marxin at gcc dot gnu.org 2022-11-13 18:33 ` pinskia at gcc dot gnu.org 2022-11-14 7:11 ` ebotcazou at gcc dot gnu.org 2022-11-14 8:44 ` marxin at gcc dot gnu.org
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=bug-107634-4@http.gcc.gnu.org/bugzilla/ \ --to=gcc-bugzilla@gcc.gnu.org \ --cc=gcc-bugs@gcc.gnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).