Continuing with PR122243 fixes, this set of patches covers about the
first third of the target-specific options sections in invoke.texi.
The goal I've been working towards with these patches is that all
options that aren't marked as "Undocumented" in the .opt file ought to
have documentation in the manual, specifically be listed in the
Options Summary (only one of the positive or negative forms unless
they have different names or syntax) and option index (both positive
and negative forms), and have at least a brief description in the
appropriate section.
In a number of cases I have added the "Undocumented" property to the
.opt file and removed documention for options that are obsolete but
still accepted for backward compatibility. My thinking is that the
options documentation in the manual is already way too long, there is
little point in documenting options that are not useful or that
trigger warnings, and that if people want to find out what some option
from a GCC of 20 years ago did they should be reading the manual from
that era.
There are some cases where I made other changes to the .opt files that
are outside of what I think I can self-approve as documentation
maintainer; I've marked those patches as "RFA". Please note also that
I have not been able to build, much less test, GCC for most of these
targets -- so while I've tried to avoid anything too scary, it's
possible that I've broken some things that affect real uses of the
affected options. Target maintainers, please take a look and let me
know if you have any concerns.
In case the target maintainers have other complaints about what I've
done in terms of deciding which options should be documented and which
shouldn't, I'll hold off on pushing any of these patches until next week
to allow time for review and feedback.
I'm planning to push a separate patch for "make regenerate-opt-urls"
(to keep those automated changes out of the things needing to be
reviewed). I also noted that the FRV and FT32 options sections are
out of alphabetical order with respect to each other -- again, I'll
fix that later to keep it separate from things that need review.
-Sandra
Sandra Loosemore (19):
doc, aarch64: Clean up aarch64 options and documentation [PR122243]
doc, epiphany: Clean up epiphany target options and docs [PR122243]
doc, gcn: Clean up gcn target options and docs [PR122243] [PR122288]
arc: Fix positive form of -mno-brcc and -mno-dpfp-lrsr options
[PR122243]
doc, arc: Undocument deprecated and deleted options [PR122243]
doc, arm: Clean up ARM option documentation [PR122243]
doc, blackfin: Don't separately document no- form of Blackfin options
[PR122243]
doc, c6x: Document missing C6X options [PR122243]
doc, cris: Clean up CRIS option documentation [PR122243]
doc, csky: C-SKY option documentation cleanup [PR122243]
doc, mingw: Clean up Cygwin and MinGW option documentation [PR122243]
doc, darwin: Clean up Darwin options and documentation [PR122243]
doc, alpha: Document missing alpha options [PR122243]
doc, bpf: Clean up eBPF option documentation [PR122243]
doc, fr30: Clean up FR30 option documentation [PR122243]
doc, ft32: Clean up FT32 options and documentation [PR122243]
doc, frv: Clean up FRV option documentation [PR122243]
doc, linux: Clean up GNU/Linux option documentation [PR122243]
doc, h8300: Clean up H8/300 option and attribute documentation
[PR122243]
gcc/config/aarch64/aarch64.opt | 2 +-
gcc/config/alpha/alpha.opt | 2 +-
gcc/config/arc/arc.opt | 67 +-
gcc/config/arm/arm.opt | 9 +-
gcc/config/cris/cris.opt | 18 +-
gcc/config/darwin.opt | 53 +-
gcc/config/epiphany/epiphany.opt | 9 +-
gcc/config/frv/frv.opt | 6 +-
gcc/config/ft32/ft32.opt | 2 +-
gcc/config/gcn/gcn.opt | 20 +-
gcc/config/h8300/h8300.opt | 4 +-
gcc/doc/extend.texi | 12 +
gcc/doc/invoke.texi | 1163 ++++++++++++++----------------
13 files changed, 681 insertions(+), 686 deletions(-)
--
2.39.5
