]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
Document locality partitioning params in invoke.texi
authorKyrylo Tkachov <ktkachov@nvidia.com>
Thu, 17 Apr 2025 17:50:44 +0000 (10:50 -0700)
committerKyrylo Tkachov <ktkachov@nvidia.com>
Tue, 22 Apr 2025 10:05:50 +0000 (12:05 +0200)
Filip Kastl pointed out that contrib/check-params-in-docs.py complains
about params not documented in invoke.texi, so this patch adds the short
explanation from params.opt for these to the invoke.texi section.
Thanks for the reminder.

Signed-off-by: Kyrylo Tkachov <ktkachov@nvidia.com>
gcc/

* doc/invoke.texi (lto-partition-locality-frequency-cutoff,
lto-partition-locality-size-cutoff, lto-max-locality-partition):
Document.

(cherry picked from commit b7fb18dcf79476aa30ed2ad6cc2eaeab1f266107)

gcc/doc/invoke.texi

index 14a78fd236f64185fc129f18b52b20692d49305c..c2e1bf8031b8f03dad39c47645ac91ae78cf44cd 100644 (file)
@@ -16961,6 +16961,19 @@ Size of max partition for WHOPR (in estimated instructions).
 to provide an upper bound for individual size of partition.
 Meant to be used only with balanced partitioning.
 
+@item lto-partition-locality-frequency-cutoff
+The denominator n of fraction 1/n of the execution frequency of callee to be
+cloned for a particular caller. Special value of 0 dictates to always clone
+without a cut-off.
+
+@item lto-partition-locality-size-cutoff
+Size cut-off for callee including inlined calls to be cloned for a particular
+caller.
+
+@item lto-max-locality-partition
+Maximal size of a locality partition for LTO (in estimated instructions).
+Value of 0 results in default value being used.
+
 @item lto-max-streaming-parallelism
 Maximal number of parallel processes used for LTO streaming.