As the subject says. There have been discussions about moving the
parameter docs out of the user-facing documentation for some years
now. Aside from the explicit disclaimer about parameters being
unstable and subject to change, the existing documentation is of poor
quality and full of jargon and "implementor-speak" that is probably
incomprehensible to most users of GCC.
I'm not entirely certain I did the right thing in part 2 of the patch
series, by simply removing all dangling references to specific
parameters in other parts of the manual. I think it could be argued
that at least some of the affected parameters ought to be exposed to
users via "real" user-visible options that are aliased to the
parameters for backward compatibility. If anybody wants me to
undertake that instead, speak up! Otherwise I'll push this series in
a few days.
-Sandra
Sandra Loosemore (3):
doc: Move parameter docs to the GCC internals manual [PR123245]
[PR89915]
doc: Remove references to parameters in user documentation [PR123245]
[PR89915]
doc: Copy-edit parameter documentation [PR89915]
gcc/Makefile.in | 3 +-
gcc/doc/gccint.texi | 12 +
gcc/doc/invoke.texi | 1831 +-----------------------------------
gcc/doc/params.texi | 2156 +++++++++++++++++++++++++++++++++++++++++++
gcc/params.opt | 98 +-
5 files changed, 2270 insertions(+), 1830 deletions(-)
create mode 100644 gcc/doc/params.texi
--
2.39.5
