]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
Doc: Add pointer to --help use to main entry for -Q option [PR90465]
authorSandra Loosemore <sloosemore@baylibre.com>
Wed, 16 Apr 2025 18:17:11 +0000 (18:17 +0000)
committerSandra Loosemore <sloosemore@baylibre.com>
Wed, 16 Apr 2025 18:27:34 +0000 (18:27 +0000)
-Q does something completely different in conjunction with --help than it
does otherwise; its main entry in the manual didn't mention that, nor did
-Q have an entry in the index for the --help usage.

gcc/ChangeLog
PR driver/90465
* doc/invoke.texi (Overall Options): Add a @cindex for -Q in
connection with --help=.
(Developer Options): Point at --help= documentation for the
other use of -Q.

gcc/doc/invoke.texi

index 0b6644b03154aacc12e60d25dd08d0b86dbf8a43..14a78fd236f64185fc129f18b52b20692d49305c 100644 (file)
@@ -2199,6 +2199,7 @@ those that have already been displayed.  If @option{--help} is also
 specified anywhere on the command line then this takes precedence
 over any @option{--help=} option.
 
+@opindex Q
 If the @option{-Q} option appears on the command line before the
 @option{--help=} option, then the descriptive text displayed by
 @option{--help=} is changed.  Instead of describing the displayed
@@ -21311,8 +21312,13 @@ Toggle @option{-fvar-tracking-assignments}, in the same way that
 
 @opindex Q
 @item -Q
-Makes the compiler print out each function name as it is compiled, and
-print some statistics about each pass when it finishes.
+When used on the command line prior to @option{--help=}, @option{-Q}
+acts as a modifier to the help output.  @xref{Overall Options},
+for details about @option{--help=}.
+
+Otherwise, this option makes the compiler print out each function name
+as it is compiled, and print some statistics about each pass when it
+finishes.
 
 @opindex ftime-report
 @item -ftime-report