[PATCH] doc: fix spelling of -fprofile-reproducibility

[PATCH] doc: fix spelling of -fprofile-reproducibility

[Sergei Trofimovich]

From: Sergei Trofimovich <siarheit@google.com>

gcc/ChangeLog:

	* doc/invoke.texi: fix '-fprofile-reproducibility' option
	spelling in maunal.
---
 gcc/doc/invoke.texi | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index bca8c856dc8..183ce7715d1 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -557,7 +557,8 @@ Objective-C and Objective-C++ Dialects}.
 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
 -fprofile-note=@var{path} -fprofile-prefix-path=@var{path} @gol
 -fprofile-update=@var{method} -fprofile-filter-files=@var{regex} @gol
--fprofile-exclude-files=@var{regex} -fprofile-reproducibility @gol
+-fprofile-exclude-files=@var{regex} @gol
+-fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]} @gol
 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
@@ -13889,14 +13890,14 @@ any of the regular expressions (separated by semi-colons).
 For example, @option{-fprofile-exclude-files=/usr/.*} will prevent instrumentation
 of all files that are located in the @file{/usr/} folder.
 
-@item -fprofile-reproducible
+@item -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]}
 @opindex fprofile-reproducible
 Control level of reproducibility of profile gathered by
 @code{-fprofile-generate}.  This makes it possible to rebuild program
 with same outcome which is useful, for example, for distribution
 packages.
 
-With @option{-fprofile-reproducibility=serial} the profile gathered by
+With @option{-fprofile-reproducible=serial} the profile gathered by
 @option{-fprofile-generate} is reproducible provided the trained program
 behaves the same at each invocation of the train run, it is not
 multi-threaded and profile data streaming is always done in the same
@@ -13911,7 +13912,7 @@ Such non-reproducible part of programs may be annotated by
 @option{-l} can be used to dump gathered data and verify that they are
 indeed reproducible.
 
-With @option{-fprofile-reproducibility=parallel-runs} collected profile
+With @option{-fprofile-reproducible=parallel-runs} collected profile
 stays reproducible regardless the order of streaming of the data into
 gcda files.  This setting makes it possible to run multiple instances of
 instrumented program in parallel (such as with @code{make -j}). This
-- 
2.28.0

Re: [PATCH] doc: fix spelling of -fprofile-reproducibility

[Richard Biener]

On Fri, Sep 11, 2020 at 11:55 PM Sergei Trofimovich via Gcc-patches
<gcc-patches@gcc.gnu.org> wrote:
>
> From: Sergei Trofimovich <siarheit@google.com>
>
> gcc/ChangeLog:
>
>         * doc/invoke.texi: fix '-fprofile-reproducibility' option
>         spelling in maunal.

OK also for the branch.

> ---
>  gcc/doc/invoke.texi | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
> index bca8c856dc8..183ce7715d1 100644
> --- a/gcc/doc/invoke.texi
> +++ b/gcc/doc/invoke.texi
> @@ -557,7 +557,8 @@ Objective-C and Objective-C++ Dialects}.
>  -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
>  -fprofile-note=@var{path} -fprofile-prefix-path=@var{path} @gol
>  -fprofile-update=@var{method} -fprofile-filter-files=@var{regex} @gol
> --fprofile-exclude-files=@var{regex} -fprofile-reproducibility @gol
> +-fprofile-exclude-files=@var{regex} @gol
> +-fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]} @gol
>  -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
>  -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
>  -fsanitize-undefined-trap-on-error  -fbounds-check @gol
> @@ -13889,14 +13890,14 @@ any of the regular expressions (separated by semi-colons).
>  For example, @option{-fprofile-exclude-files=/usr/.*} will prevent instrumentation
>  of all files that are located in the @file{/usr/} folder.
>
> -@item -fprofile-reproducible
> +@item -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]}
>  @opindex fprofile-reproducible
>  Control level of reproducibility of profile gathered by
>  @code{-fprofile-generate}.  This makes it possible to rebuild program
>  with same outcome which is useful, for example, for distribution
>  packages.
>
> -With @option{-fprofile-reproducibility=serial} the profile gathered by
> +With @option{-fprofile-reproducible=serial} the profile gathered by
>  @option{-fprofile-generate} is reproducible provided the trained program
>  behaves the same at each invocation of the train run, it is not
>  multi-threaded and profile data streaming is always done in the same
> @@ -13911,7 +13912,7 @@ Such non-reproducible part of programs may be annotated by
>  @option{-l} can be used to dump gathered data and verify that they are
>  indeed reproducible.
>
> -With @option{-fprofile-reproducibility=parallel-runs} collected profile
> +With @option{-fprofile-reproducible=parallel-runs} collected profile
>  stays reproducible regardless the order of streaming of the data into
>  gcda files.  This setting makes it possible to run multiple instances of
>  instrumented program in parallel (such as with @code{make -j}). This
> --
> 2.28.0
>