On 23/09/16 02:21, Sandra Loosemore wrote:
> On 09/22/2016 07:52 AM, Richard Earnshaw (lists) wrote:
>> On 11/07/16 17:56, Andre Vieira (lists) wrote:
>>> +
>>> diff --git a/gcc/target.def b/gcc/target.def
>>> index
>>> a4df363698ce776b51d11c187baed2069ba88a52..a3d46fa48d919a16699c33b2b78236e62a33e025
>>> 100644
>>> --- a/gcc/target.def
>>> +++ b/gcc/target.def
>>> @@ -432,6 +432,19 @@ this section is associated.",
>>> void, (const char *name, unsigned int flags, tree decl),
>>> default_no_named_section)
>>>
>>> +/* Tell assembler what section attributes to assign this elf section
>>> + declaration, using their numerical value. */
>>> +DEFHOOK
>>> +(elf_flags_numeric,
>>> + "If the target needs to represent ELF section attributes using
>>> their\n\
>>> +numerical value, then this hook should be implemented to return true
>>> and\n\
>>> +write the numerical value of @var{flags} in @var{num}. This
>>> function is\n\
>>> +called by @code{default_elf_asm_named_section}, which prints
>>> @var{num}\n\
>>> +as the value representing the ELF section attributes if this
>>> function\n\
>>> +returns true.",
>>
>>
>> I think this should read something like.
>>
>> This hook can be used to encode ELF section flags for which no letter
>> code has been defined in the assembler. It is called by
>> @code{default_asm_named_section} whenever the section flags need to be
>> emitted in the assembler output. If the hook returns true, then the
>> numerical value for ELF section flags should be calculated from
>> @var{flags} and saved in @var{*num}; the value will be printed out
>> instead of the normal sequence of letter codes. If the hook is not
>> defined, or if it returns false, then @var{num} will be ignored and the
>> traditional letter sequence will be emitted.
>
> Can we please write this in the present tense instead of the future,
> assuming it describes current behavior (as modified by the patch)?
>
> s/will be/is/g
>
> -Sandra
>
Hi Sandra,
Is this better?
Cheers,
Andre
gcc/ChangeLog
2016-09-23 Andre Vieira <andre.simoesdiasvie...@arm.com>
* target.def(elf_flags_numeric): Change documentation to
present tense.
>From 459abfbbd836aa11e71dd90b9466c60b1155fba0 Mon Sep 17 00:00:00 2001
From: Andre Simoes Dias Vieira <andre.simoesdiasvie...@arm.com>
Date: Fri, 23 Sep 2016 09:16:17 +0100
Subject: [PATCH] Language fix for elf_flags_numeric doc
---
gcc/target.def | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/gcc/target.def b/gcc/target.def
index ac693318adaaa230ea300f10bc37282881d9da6f..4adb8aabc6548889b717abc9310e98f0e6fc161b 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -441,10 +441,10 @@ code has been defined in the assembler. It is called by\n\
@code{default_asm_named_section} whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value will be printed out\n\
-instead of the normal sequence of letter codes. If the hook is not\n\
-defined, or if it returns false, then @var{num} will be ignored and the\n\
-traditional letter sequence will be emitted.",
+@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+normal sequence of letter codes. If the hook is not defined, or if it\n\
+returns false, then @var{num} is ignored and the traditional letter sequence\n\
+is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_uint_uintp_false)
--
1.9.1
