diff mbox

[DOC] symbol rename pragmas

Message ID 5376BA26.9070406@LimeGreenSocks.com
State New
Headers show

Commit Message

David Wohlferd May 17, 2014, 1:23 a.m. UTC
This patch is in response to Rainer Orth's comment (below).

I have a release on file with the FSF, but don't have SVN write access.

Problem description:
The (already committed) patch at the top of this thread removed a 
reference to Solaris.  It has been requested that this be restored to 
show the origins of the directive and clarify "when to use it (or not)."

ChangeLog:
2014-05-16  David Wohlferd  <dw@LimeGreenSocks.com>

          * doc/extend.texi (Symbol-Renaming Pragmas): Restore (slightly
           modified) reference to Solaris.

dw

>> keep documenting the heritage so it's clear why it
>> exists and when to use it (or not).
>>
>> Just restoring the first sentence you deleted describing the heritage
>> should be enough to do so.
>
> Speaking for myself, I didn't see the old text as favoring one course 
> of action over another.  How would you feel about:
>
> GCC supports a @code{#pragma} directive that changes the name used in
> assembly for a given declaration. While this pragma is supported on all
> platforms, it is intended primarily to provide compatibility with the
> Solaris system headers. This effect can also be achieved using the asm
> labels extension (@pxref{Asm Labels}).
>
> To me, this subtly discourages using the pragma other than for 
> Solaris, maintains the heritage, and immediately provides a viable 
> alternative for other platforms.
diff mbox

Patch

Index: extend.texi
===================================================================
--- extend.texi	(revision 210542)
+++ extend.texi	(working copy)
@@ -16895,8 +16895,10 @@ 
 @subsection Symbol-Renaming Pragmas
 
 GCC supports a @code{#pragma} directive that changes the name used in
-assembly for a given declaration. This effect can also be achieved
-using the asm labels extension (@pxref{Asm Labels}).
+assembly for a given declaration. While this pragma is supported on all
+platforms, it is intended primarily to provide compatibility with the
+Solaris system headers. This effect can also be achieved using the asm
+labels extension (@pxref{Asm Labels}).
 
 @table @code
 @item redefine_extname @var{oldname} @var{newname}