diff mbox series

[DOCS,AArch64] Add missing documenation for mbranch-protection

Message ID 132fd8dc-c723-b2ca-3bb9-457c60ead9e5@arm.com
State New
Headers show
Series [DOCS,AArch64] Add missing documenation for mbranch-protection | expand

Commit Message

Sudakshina Das April 2, 2019, 12:45 p.m. UTC
Hi

This patch add the missing documentation bits for -mbranch-protection in 
both extend.texi and invoke.texi.

Is this ok for trunk?

Sudi

*** gcc/ChangeLog ***

2019-xx-xx  Sudakshina Das  <sudi.das@arm.com>

	* doc/extend.texi: Add deprecated comment on sign-return-address
	function attribute and add mbranch-protection.
	* doc/invoke.texi: Add bti to the options for mbranch-protection.

Comments

Sandra Loosemore April 2, 2019, 3:32 p.m. UTC | #1
On 4/2/19 6:45 AM, Sudakshina Das wrote:
> Hi
> 
> This patch add the missing documentation bits for -mbranch-protection in
> both extend.texi and invoke.texi.
> 
> Is this ok for trunk?
> 
> diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
> index ef7adb6a9c0fe1abd769e237fd8d0ce4c614aef8..7e1c28182138aeba163e50f5b7ed60812c1dfe27 100644
> --- a/gcc/doc/extend.texi
> +++ b/gcc/doc/extend.texi
> @@ -3925,7 +3925,15 @@ same as for the @option{-mcpu=} command-line option.
>  @cindex @code{sign-return-address} function attribute, AArch64
>  Select the function scope on which return address signing will be applied.  The
>  behavior and permissible arguments are the same as for the command-line option
> -@option{-msign-return-address=}.  The default value is @code{none}.
> +@option{-msign-return-address=}.  The default value is @code{none}.  This
> +attribute is @code{deprecated}.  The @code{branch-protection} attribute should
> +be used instead.

s/@code{deprecated}/deprecated/

The patch is OK with that tweak.

-Sandra
Sudakshina Das April 3, 2019, 10:04 a.m. UTC | #2
Hi Sandra

On 02/04/2019 16:32, Sandra Loosemore wrote:
> On 4/2/19 6:45 AM, Sudakshina Das wrote:
>> Hi
>>
>> This patch add the missing documentation bits for -mbranch-protection in
>> both extend.texi and invoke.texi.
>>
>> Is this ok for trunk?
>>
>> diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
>> index 
>> ef7adb6a9c0fe1abd769e237fd8d0ce4c614aef8..7e1c28182138aeba163e50f5b7ed60812c1dfe27 
>> 100644
>> --- a/gcc/doc/extend.texi
>> +++ b/gcc/doc/extend.texi
>> @@ -3925,7 +3925,15 @@ same as for the @option{-mcpu=} command-line 
>> option.
>>  @cindex @code{sign-return-address} function attribute, AArch64
>>  Select the function scope on which return address signing will be 
>> applied.  The
>>  behavior and permissible arguments are the same as for the 
>> command-line option
>> -@option{-msign-return-address=}.  The default value is @code{none}.
>> +@option{-msign-return-address=}.  The default value is @code{none}.  
>> This
>> +attribute is @code{deprecated}.  The @code{branch-protection} 
>> attribute should
>> +be used instead.
> 
> s/@code{deprecated}/deprecated/
> 
> The patch is OK with that tweak.

Thanks. I have made the change and committed as r270119.

Sudi
> 
> -Sandra
diff mbox series

Patch

diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index ef7adb6a9c0fe1abd769e237fd8d0ce4c614aef8..7e1c28182138aeba163e50f5b7ed60812c1dfe27 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -3925,7 +3925,15 @@  same as for the @option{-mcpu=} command-line option.
 @cindex @code{sign-return-address} function attribute, AArch64
 Select the function scope on which return address signing will be applied.  The
 behavior and permissible arguments are the same as for the command-line option
-@option{-msign-return-address=}.  The default value is @code{none}.
+@option{-msign-return-address=}.  The default value is @code{none}.  This
+attribute is @code{deprecated}.  The @code{branch-protection} attribute should
+be used instead.
+
+@item branch-protection
+@cindex @code{branch-protection} function attribute, AArch64
+Select the function scope on which branch protection will be applied.  The
+behavior and permissible arguments are the same as for the command-line option
+@option{-mbranch-protection=}.  The default value is @code{none}.
 
 @end table
 
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 029b33a688060a558bb7b78312f090c64e6d0a4a..27b51aaab99680180f46383e5a4b22f7f3ceea91 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -632,7 +632,7 @@  Objective-C and Objective-C++ Dialects}.
 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
 -mpc-relative-literal-loads @gol
 -msign-return-address=@var{scope} @gol
--mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}] @gol
+-mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}]|@var{bti} @gol
 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
 -moverride=@var{string}  -mverbose-cost-dump @gol
 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{sysreg} @gol
@@ -15884,7 +15884,7 @@  functions, and @samp{all}, which enables pointer signing for all functions.  The
 default value is @samp{none}. This option has been deprecated by
 -mbranch-protection.
 
-@item -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}]
+@item -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}]|@var{bti}
 @opindex mbranch-protection
 Select the branch protection features to use.
 @samp{none} is the default and turns off all types of branch protection.