[PATCH (pushed)] docs: document --param=ipa-sra-ptrwrap-growth-factor

[PATCH (pushed)] docs: document --param=ipa-sra-ptrwrap-growth-factor

[Martin Liška]

gcc/ChangeLog:

	* doc/invoke.texi: Document ipa-sra-ptrwrap-growth-factor.
---
 gcc/doc/invoke.texi | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 0459714d100..7dc1d45e275 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -15520,6 +15520,11 @@ parameters only when their cumulative size is less or equal to
 @option{ipa-sra-ptr-growth-factor} times the size of the original
 pointer parameter.
 
+@item ipa-sra-ptrwrap-growth-factor
+Additional maximum allowed growth of total size of new parameters
+that ipa-sra replaces a pointer to an aggregate with,
+if it points to a local variable that the caller never writes to.
+
 @item ipa-sra-max-replacements
 Maximum pieces of an aggregate that IPA-SRA tracks.  As a
 consequence, it is also the maximum number of replacements of a formal
-- 
2.38.1

Re: [PATCH (pushed)] docs: document --param=ipa-sra-ptrwrap-growth-factor

[Martin Jambor]

Hi,

On Wed, Dec 14 2022, Martin Liška wrote:
> gcc/ChangeLog:
>
> 	* doc/invoke.texi: Document ipa-sra-ptrwrap-growth-factor.

Thanks or spotting this.  Seeing the email also averted me to the fact
that what I wrote in the parameter description is almost the opposite of
what it should say.  I'll fix that momentarily with the following patch.

Thanks again,

Martin



Somehow I made the description of the parameter almost the opposite of
what I wanted to say.  Fixed by this patch.

Tested by building gcc on x86_64-linux and make info and make pdf.

gcc/ChangeLog:

2022-12-14  Martin Jambor  <mjambor@suse.cz>

	* doc/invoke.texi (ipa-sra-ptrwrap-growth-factor): Fix the
	description.
	* params.opt (ipa-sra-ptrwrap-growth-factor): Likewise.
---
 gcc/doc/invoke.texi | 3 ++-
 gcc/params.opt      | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 7dc1d45e275..f48df64cc2a 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -15523,7 +15523,8 @@ pointer parameter.
 @item ipa-sra-ptrwrap-growth-factor
 Additional maximum allowed growth of total size of new parameters
 that ipa-sra replaces a pointer to an aggregate with,
-if it points to a local variable that the caller never writes to.
+if it points to a local variable that the caller only writes to and
+passes it as an argument to other functions.
 
 @item ipa-sra-max-replacements
 Maximum pieces of an aggregate that IPA-SRA tracks.  As a
diff --git a/gcc/params.opt b/gcc/params.opt
index e0fd05fb44a..e0380bf10f9 100644
--- a/gcc/params.opt
+++ b/gcc/params.opt
@@ -296,7 +296,7 @@ Maximum allowed growth of total size of new parameters that ipa-sra replaces a p
 
 -param=ipa-sra-ptrwrap-growth-factor=
 Common Joined UInteger Var(param_ipa_sra_ptrwrap_growth_factor) Init(4) IntegerRange(1, 8) Param Optimization
-Additional maximum allowed growth of total size of new parameters that ipa-sra replaces a pointer to an aggregate with, if it points to a local variable that the caller never writes to.
+Additional maximum allowed growth of total size of new parameters that ipa-sra replaces a pointer to an aggregate with, if it points to a local variable that the caller only writes to and passes it as an argument to functions.
 
 -param=ira-loop-reserved-regs=
 Common Joined UInteger Var(param_ira_loop_reserved_regs) Init(2) Param Optimization
-- 
2.38.1