On 10/4/25 12:00, Andrew Pinski wrote:
Not a documentation maintainer but as someone who points others to the
documentation (due to bug triaging); I do find it would be useful to
have both forms listed rather than a mix of one or the other. Having
just the positive is also ok with me though not as good as both but
still much better than the current situation.
The current situation is a mix of:
* negative form (mostly older options I think)
* positive form (in some cases even if default)
* both forms (some of the new options and depends on the person adding them)
We have 3 places where options are listed:
- the option summary tables
- the detailed documentation
- the option index
I think in many/most cases we are already listing both forms in the
option index, and we ought to continue to do that (and fix instances
where index entries are missing). I also don't have a big issue with
listing both forms in the detailed documentation, but for the option
summaries I'd really like to list only a single form in a uniform way,
properly alphabetize those lists, and reformat those lists so that there
is a direct link to the detailed documentation for each option (as the
index already does) instead of just the overall node like "Debugging
Options". Alternatively, I'm open to the idea that the option summary
lists are redundant and we could delete them entirely so that we have
only one big list in the index that is alphabetized automatically
(without needing additional effort from us to keep it that way and in
sync with the other places) and the detailed documentation grouped by topic.
Of course the root of the problem is that GCC has too many options and
people keep adding more all the time! :-P So I'm just throwing out
some ideas on what we might do to both make the documentation more
helpful to users and reduce maintenance overhead for us.
-Sandra
