doc: invoke: RISC-V: Clean up the -memit-attribute wording

Message ID 20220208032021.1400-1-palmer@rivosinc.com
State Deferred, archived
Headers
Series doc: invoke: RISC-V: Clean up the -memit-attribute wording |

Commit Message

Palmer Dabbelt Feb. 8, 2022, 3:20 a.m. UTC
  The previous wording makes it sound like "do not emit" is a
clarification of "emit", which is not accurate.  This cleans up the
wording to match (most) of the other arguments.

gcc/ChangeLog

	* doc/invoke.texi (RISC-V -memit-attribute): Re-word the do/do
	not language.

Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
---
 gcc/doc/invoke.texi | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
  

Comments

Kito Cheng Feb. 8, 2022, 9:09 a.m. UTC | #1
Hi Palmer:

Seems like...you update the wrong part? you are updating
-mmcount-ra-address/-mno-mcount-ra-address rather than
-memit-attribute/ -mno-emit-attribute ?

On Tue, Feb 8, 2022 at 12:30 PM Palmer Dabbelt <palmer@rivosinc.com> wrote:
>
> The previous wording makes it sound like "do not emit" is a
> clarification of "emit", which is not accurate.  This cleans up the
> wording to match (most) of the other arguments.
>
> gcc/ChangeLog
>
>         * doc/invoke.texi (RISC-V -memit-attribute): Re-word the do/do
>         not language.
>
> Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
> ---
>  gcc/doc/invoke.texi | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
> index 8bd5293fce7..0ebe538ccdc 100644
> --- a/gcc/doc/invoke.texi
> +++ b/gcc/doc/invoke.texi
> @@ -26294,12 +26294,11 @@ assembler and the linker alone without help from the compiler.
>  @itemx -mno-mcount-ra-address
>  @opindex mmcount-ra-address
>  @opindex mno-mcount-ra-address
> -Emit (do not emit) code that allows @code{_mcount} to modify the
> -calling function's return address.  When enabled, this option extends
> -the usual @code{_mcount} interface with a new @var{ra-address}
> -parameter, which has type @code{intptr_t *} and is passed in register
> -@code{$12}.  @code{_mcount} can then modify the return address by
> -doing both of the following:
> +Do or do not emit code that allows @code{_mcount} to modify the calling
> +function's return address.  When enabled, this option extends the usual
> +@code{_mcount} interface with a new @var{ra-address} parameter, which has type
> +@code{intptr_t *} and is passed in register @code{$12}.  @code{_mcount} can
> +then modify the return address by doing both of the following:
>  @itemize
>  @item
>  Returning the new address in register @code{$31}.
> --
> 2.34.1
>
  

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 8bd5293fce7..0ebe538ccdc 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -26294,12 +26294,11 @@  assembler and the linker alone without help from the compiler.
 @itemx -mno-mcount-ra-address
 @opindex mmcount-ra-address
 @opindex mno-mcount-ra-address
-Emit (do not emit) code that allows @code{_mcount} to modify the
-calling function's return address.  When enabled, this option extends
-the usual @code{_mcount} interface with a new @var{ra-address}
-parameter, which has type @code{intptr_t *} and is passed in register
-@code{$12}.  @code{_mcount} can then modify the return address by
-doing both of the following:
+Do or do not emit code that allows @code{_mcount} to modify the calling
+function's return address.  When enabled, this option extends the usual
+@code{_mcount} interface with a new @var{ra-address} parameter, which has type
+@code{intptr_t *} and is passed in register @code{$12}.  @code{_mcount} can
+then modify the return address by doing both of the following:
 @itemize
 @item
 Returning the new address in register @code{$31}.