For PR122243 I have been trying to systematically identify GCC
command-line options that are missing documentation, and fixing them.
I've found that most of problems fall into one of three categories:
(1) Options that should be documented, but are missing from at least one
of the three places -- option summary, detailed documentation, and
index -- where they should be listed.
(2) Obsolete or internal options that should not be documented, but are
not flagged as "Ignore" or "Undocumented" in the .opt file.
(3) "-no" options that shouldn't exist at all but where the entry in the
.opt file is missing "RejectNegative".
Taking care of the (1) issues is within my domain as documentation
maintainer, but (2) and (3) are probably not something I can
self-approve. I've tried to use my best judgement about which options
are really obsolete/useless and which we should document for users,
but maybe people who know more about the history of those options have
other ideas. So, please look over these patches and let me know if
I'm barking up the wrong tree. I've cc'ed Joseph as option handling
maintainer, but I'm not sure that's the right role for the things that
need fixing here; if other people want to jump in and propose other
solutions or policies, that's fine too.
Besides the 11 patches in this current series, I have 20 more pieces
(so far -- I'm only about halfway through the list) in progress to
clean up the target-specific options in similar ways. There I'm
running into an additional problem that I'm not set up to build or
test many of the targets that need (sometimes substantial) cleanup of
the .opt file; I may need to enlist help from the target maintainers
to test as well as review.
Anyway, after rebasing the whole set a few days ago, I realized it
would be helpful to get at least some of the patches in sooner instead
of later so that there's less stuff to get bit-rotten while I'm still
working my way through the remaining parts; hence me posting this
subset now even though there's still a lot more to come.
-Sandra
Sandra Loosemore (11):
Fix typos in @opindex entries [PR122243]
Add some missing @opindex entries [PR122243]
Mark some unused/undocumented options as "Ignore" [PR122243]
Add "RejectNegative" to some options where it doesn't make sense
[PR122243]
Mark some undocumented options as such [PR122243]
Add missing options to option summary [PR122243]
Only document -A/--assert options in cpp manual [PR122243]
Document long-form command-line options [PR122243]
Add missing documentation for some -f, -g, and -W options [PR122243]
[PR120064]
Document linker options + -Q and -S [PR122243]
Documentation for -fident and -Qy/-Qn options [PR122243]
gcc/analyzer/analyzer.opt | 2 +-
gcc/c-family/c.opt | 34 +--
gcc/common.opt | 77 ++++---
gcc/doc/cppdiropts.texi | 34 ++-
gcc/doc/cppopts.texi | 59 +++++-
gcc/doc/invoke.texi | 428 ++++++++++++++++++++++++++++++--------
6 files changed, 490 insertions(+), 144 deletions(-)
--
2.39.5
