diff mbox

[documentation] Fix documentation of --param

Message ID 56B36353.60302@embecosm.com
State New
Headers show

Commit Message

Jeremy Bennett Feb. 4, 2016, 2:42 p.m. UTC
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

The attached patch corrects some errors in documentation of the --param
option to gcc. Mostly they are corrections to the names of options,
but two parameters are documented which do not exist in trunk.

gcc/ChangeLog:

	* doc/invoke.texi (Optimize Options): In table of --param options
	rename second occurrence of tracer-min-branch-ratio to
	tracer-min-branch-probability, rename
	tracer-min-branch-ratio-feedback to
	tracer-min-branch-probability-feedback and clarify description,
	rename sched-spec-state-edge-prob-cutoff to
	sched-state-edge-prob-cutoff, rename selsched-max-insns-to-rename
	to selsched-insns-to-rename, rename lto-minpartition to
	lto-min-partition, delete reorder-blocks-duplicate and
	reorder-blocks-duplicate-feedback.

Jeremy

- -- 
Tel:     +44 (1590) 610184
Cell:    +44 (7970) 676050
SkypeID: jeremybennett
Twitter: @jeremypbennett
Email:   jeremy.bennett@embecosm.com
Web:     www.embecosm.com
PGP key: 1024D/BEF58172FB4754E1 2009-03-20
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iEYEARECAAYFAlazY1MACgkQvvWBcvtHVOEQhACeNoh1EUJMNdnnIVbwfEDLLxlC
bLQAn0T7BWxXzz2onVqC0HBFad1spFXK
=pnxt
-----END PGP SIGNATURE-----

Comments

Sandra Loosemore Feb. 4, 2016, 10:28 p.m. UTC | #1
On 02/04/2016 07:42 AM, Jeremy Bennett wrote:
>
> The attached patch corrects some errors in documentation of the --param
> option to gcc. Mostly they are corrections to the names of options,
> but two parameters are documented which do not exist in trunk.
>
> gcc/ChangeLog:
>
> 	* doc/invoke.texi (Optimize Options): In table of --param options
> 	rename second occurrence of tracer-min-branch-ratio to
> 	tracer-min-branch-probability, rename
> 	tracer-min-branch-ratio-feedback to
> 	tracer-min-branch-probability-feedback and clarify description,
> 	rename sched-spec-state-edge-prob-cutoff to
> 	sched-state-edge-prob-cutoff, rename selsched-max-insns-to-rename
> 	to selsched-insns-to-rename, rename lto-minpartition to
> 	lto-min-partition, delete reorder-blocks-duplicate and
> 	reorder-blocks-duplicate-feedback.

This looks OK.  Thanks for tracking down these errors!

-Sandra
diff mbox

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index fcc404e..45346ad 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -8987,16 +8987,18 @@  growth.
 Stop reverse growth when the reverse probability of best edge is less than this
 threshold (in percent).
 
-@item tracer-min-branch-ratio
-@itemx tracer-min-branch-ratio-feedback
+@item tracer-min-branch-probability
+@itemx tracer-min-branch-probability-feedback
 
 Stop forward growth if the best edge has probability lower than this
 threshold.
 
-Similarly to @option{tracer-dynamic-coverage} two values are present, one for
-compilation for profile feedback and one for compilation without.  The value
-for compilation with profile feedback needs to be more conservative (higher) in
-order to make tracer effective.
+Similarly to @option{tracer-dynamic-coverage} two parameters are
+provided.  @option{tracer-min-branch-probability-feedback} is used for
+compilation with profile feedback and @option{tracer-min-branch-probability}
+compilation without.  The value for compilation with profile feedback
+needs to be more conservative (higher) in order to make tracer
+effective.
 
 @item max-cse-path-length
 
@@ -9052,20 +9054,6 @@  The maximum number of memory locations cselib should take into account.
 Increasing values mean more aggressive optimization, making the compilation time
 increase with probably slightly better performance.  The default value is 500.
 
-@item reorder-blocks-duplicate
-@itemx reorder-blocks-duplicate-feedback
-
-Used by the basic block reordering pass to decide whether to use unconditional
-branch or duplicate the code on its destination.  Code is duplicated when its
-estimated size is smaller than this value multiplied by the estimated size of
-unconditional jump in the hot spots of the program.
-
-The @option{reorder-block-duplicate-feedback} parameter
-is used only when profile
-feedback is available.  It may be set to higher values than
-@option{reorder-block-duplicate} since information about the hot spots is more
-accurate.
-
 @item max-sched-ready-insns
 The maximum number of instructions ready to be issued the scheduler should
 consider at any given time during the first scheduling pass.  Increasing
@@ -9105,7 +9093,7 @@  The minimal probability of speculation success (in percents), so that
 speculative insns are scheduled.
 The default value is 40.
 
-@item sched-spec-state-edge-prob-cutoff
+@item sched-state-edge-prob-cutoff
 The minimum probability an edge must have for the scheduler to save its
 state across it.
 The default value is 10.
@@ -9124,7 +9112,7 @@  The maximum number of times that an instruction is scheduled during
 selective scheduling.  This is the limit on the number of iterations
 through which the instruction may be pipelined.  The default value is 2.
 
-@item selsched-max-insns-to-rename
+@item selsched-insns-to-rename
 The maximum number of best instructions in the ready list that are considered
 for renaming in the selective scheduler.  The default value is 2.
 
@@ -9394,7 +9382,7 @@  Specify desired number of partitions produced during WHOPR compilation.
 The number of partitions should exceed the number of CPUs used for compilation.
 The default value is 32.
 
-@item lto-minpartition
+@item lto-min-partition
 Size of minimal partition for WHOPR (in estimated instructions).
 This prevents expenses of splitting very small programs into too many
 partitions.