On 14/12/17 18:23, Sandra Loosemore wrote:
On 12/14/2017 10:56 AM, Kyrill Tkachov wrote:

2017-12-14  Kyrylo Tkachov  <kyrylo.tkac...@arm.com>

     * doc/invoke.texi (GCC Developer options): Add Target-specific
     developer options subsection.  Populate it with AArch64 and ARM
     options.
>
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 0d565b4..00de74c 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -14223,6 +14223,24 @@ Print the compiler's built-in specs---and don't do anything else. (This
 is used when GCC itself is being built.)  @xref{Spec Files}.
 @end table

+@subsection Target-specific developer options

Throughout this patch, please capitalize the first word of the section titles, and add @node and @cindex for each section. There are plenty of examples in this chapter to copy the style from.


Thanks, done.

+Some targets define additional debug options that are documented here.
+@subsubsection AArch64 developer options
+@table @gcctabopt
+@item -mverbose-cost-dump
+Enable verbose cost model dumping in the debug dump files.
+@item -moverride=
+Override CPU optimization parameters.

What parameters are these? What is the syntax? This isn't enough information to be useful.


I'm afraid I don't know. I've not used this option myself, I'm just aware of its existence. Do you think it's better to leave it out altogether and document it separately at a later date
(or ping its author to document it perhaps)?

+@end table
+
+@subsubsection ARM developer options
+@table @gcctabopt
+@item -mverbose-cost-dump
+Enable verbose cost model dumping in the debug dump files.
+@item -mflip-thumb
+Switch ARM/Thumb modes on alternating functions.
+@end table
+
 @node Submodel Options
 @section Machine-Dependent Options
 @cindex submodel options

Please also list the new options in the "Option Summary" section. Note that the list for developer options is currently mostly alphabetized.


Thanks, done. I haven't created a new Target-specific developers options table but instead listed the targets the options apply to in parentheses.
Attached is the latest iteration.

Thank you for the review,
Kyrill

2017-12-14  Kyrylo Tkachov  <kyrylo.tkac...@arm.com>

    * doc/invoke.texi (GCC Developer options): Add Target-specific
    developer options subsection.  Populate it with AArch64 and ARM
    options.
    (Options Summary): List the above.
commit 1c92b22d63cc16296cbbbcf4791951971b62094d
Author: Kyrylo Tkachov <kyrylo.tkac...@arm.com>
Date:   Thu Dec 14 17:44:22 2017 +0000

    [doc] Add target-specific developer options subsection

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 0d565b4..b8936d1 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -574,6 +574,8 @@ Objective-C and Objective-C++ Dialects}.
 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
 -fvar-tracking-assignments-toggle  -gtoggle @gol
+-mflip-thumb (ARM) -moverride=@var{string} (AArch64) @gol
+-mverbose-cost-dump (ARM, AArch64) @gol
 -print-file-name=@var{library}  -print-libgcc-file-name @gol
 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
@@ -14223,6 +14225,31 @@ Print the compiler's built-in specs---and don't do anything else.  (This
 is used when GCC itself is being built.)  @xref{Spec Files}.
 @end table
 
+@node Target-specific Developer Options
+@cindex target-specific developer options
+@subsection Target-specific Developer Options
+Some targets define additional debug options that are documented here.
+
+@node AArch64 Developer Options
+@cindex aarch64 developer options
+@subsubsection AArch64 Developer Options
+@table @gcctabopt
+@item -moverride=
+Override CPU optimization parameters.
+@item -mverbose-cost-dump
+Enable verbose cost model dumping in the debug dump files.
+@end table
+
+@node ARM Developer Options
+@cindex arm developer options
+@subsubsection ARM Developer Options
+@table @gcctabopt
+@item -mflip-thumb
+Switch ARM/Thumb modes on alternating functions.
+@item -mverbose-cost-dump
+Enable verbose cost model dumping in the debug dump files.
+@end table
+
 @node Submodel Options
 @section Machine-Dependent Options
 @cindex submodel options

Reply via email to