https://gcc.gnu.org/bugzilla/show_bug.cgi?id=114738

            Bug ID: 114738
           Summary: [14 Regression] Default DOCUMENTATION_ROOT_URL vs.
                    release branches
           Product: gcc
           Version: 14.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: other
          Assignee: unassigned at gcc dot gnu.org
          Reporter: jakub at gcc dot gnu.org
  Target Milestone: ---

gcc/configure.ac uses DOCUMENTATION_ROOT_URL="https://gcc.gnu.org/onlinedocs/";
as the default documentation root.  That is great for the trunk, but I'm not
convinced
it is the right thing for release branches.  The online docs at that location
are updated daily from the trunk, while the release branches will be supported
for ~ 3 years, during which a lot of the URLs hardcoded into the releases or
snapshots on release branches might get removed, the documentation changed etc.
Another option would be to switch that default on release branches to
docrootbase=
case "$gcc_version" in
*.[123456].0) docrootbase="$gcc_version/";;
*.[123456].1) docrootbase="`echo $gcc_version | sed 's/1$/0$/'`/";;
esac
DOCUMENTATION_ROOT_URL="https://gcc.gnu.org/onlinedocs/$docrootbase";
or so.  That has the advantage that the URLs will reflect the corresponding
release's stable documentation for the 3 years (or even after it goes out of
support).
The disadvantage is that unlike the trunk online docs regenerated every day,
the release onlinedocs are only created when release is made.
So, say 14.1.0 docs will be correct, but if something in the docs or in the
options is changed in 14.1.1 between 14.1.0 and 14.2.0, the URLs on the release
branches might be stale.

Reply via email to