Re: [PATCH] aarch64: Fix the documentation on :pg_hi21:

[Richard Earnshaw <rearnsha at arm dot com>]

On 03/06/14 21:20, Martin Storsjö wrote:
> On Mon, 2 Jun 2014, Martin Storsjo wrote:
> 
>> The syntax described, including a leading '#', was not supported
>> in practice. (For :lo12: it is optional.)
>> ---
>> Added a ChangeLog entry.
>> ---
>> gas/ChangeLog          |  4 ++++
>> gas/doc/c-aarch64.texi | 10 +++++-----
>> 2 files changed, 9 insertions(+), 5 deletions(-)
>>
>> diff --git a/gas/ChangeLog b/gas/ChangeLog
>> index 98186d3..911511e 100644
>> --- a/gas/ChangeLog
>> +++ b/gas/ChangeLog
>> @@ -1,3 +1,7 @@
>> +2014-06-02  Martin Storsjo  <martin@martin.st>
>> +
>> +	* doc/c-aarch64.texi: Fix the documentation on :pg_hi21:.
>> +
>> 2014-05-22  Alan Modra  <amodra@gmail.com>
>>
>> 	* listing.c (listing_warning, listing_error): Add space after colon.
>> diff --git a/gas/doc/c-aarch64.texi b/gas/doc/c-aarch64.texi
>> index cce4f61..3d84123 100644
>> --- a/gas/doc/c-aarch64.texi
>> +++ b/gas/doc/c-aarch64.texi
>> @@ -186,24 +186,24 @@ For example to load the 48-bit absolute address of @var{foo} into x0:
>> @cindex ADRP, ADD, LDR/STR group relocations, AArch64
>> Relocations for @samp{ADRP}, and @samp{ADD}, @samp{LDR} or @samp{STR}
>> instructions can be generated by prefixing the label with
>> -@samp{#:pg_hi21:} and @samp{#:lo12:} respectively.
>> +@samp{:pg_hi21:} and @samp{:lo12:} respectively.
>>
>> For example to use 33-bit (+/-4GB) pc-relative addressing to
>> load the address of @var{foo} into x0:
>>
>> @smallexample
>> -        adrp x0, #:pg_hi21:foo
>> +        adrp x0, :pg_hi21:foo
>>         add  x0, x0, #:lo12:foo
>> @end smallexample
>>
>> Or to load the value of @var{foo} into x0:
>>
>> @smallexample
>> -        adrp x0, #:pg_hi21:foo
>> +        adrp x0, :pg_hi21:foo
>>         ldr  x0, [x0, #:lo12:foo]
>> @end smallexample
>>
>> -Note that @samp{#:pg_hi21:} is optional.
>> +Note that @samp{:pg_hi21:} is optional.
>>
>> @smallexample
>>         adrp x0, foo
>> @@ -212,7 +212,7 @@ Note that @samp{#:pg_hi21:} is optional.
>> is equivalent to
>>
>> @smallexample
>> -        adrp x0, #:pg_hi21:foo
>> +        adrp x0, :pg_hi21:foo
>> @end smallexample
>>
>> @node AArch64 Floating Point
>> -- 
>> 1.8.5.2 (Apple Git-48)
> 
> Can someone apply and push this one? It was approved by Marcus yesterday, 
> but since I can't push it myself, the ChangeLog has gotten another 
> conflicting entry now - so whoever applies it will have to fix it up. (I 
> won't try to send a new resolved patch because someone else will probably 
> touch the ChangeLog inbetween again, before someone gets to pushing it.)
> 

This is why we ask for ChangeLog entries to not be sent as patches.
It's far easier to paste

<date> Martin Storsjo  <martin@martin.st>

	* doc/c-aarch64.texi: Fix the documentation on :pg_hi21:.

directly into the ChangeLog file (inserting the correct date) when
preparing the patch for upload than to resolve the conflicts that occur
when trying to apply a conflicting diff.  The date is the date the patch
is applied, not the date you posted it, so it will most likely have to
be fixed up anyway.

R.