diff mbox

[trans-mem] document -fgnu-tm

Message ID 4EB2BA34.9020907@redhat.com
State New
Headers show

Commit Message

Aldy Hernandez Nov. 3, 2011, 3:58 p.m. UTC
It seems we documented libitm, and forgot to document the main switch :).

OK for branch?
* doc/invoke.texi (C Dialect Options): Document -fgnu-tm.

Comments

Richard Henderson Nov. 3, 2011, 5:25 p.m. UTC | #1
On 11/03/2011 08:58 AM, Aldy Hernandez wrote:
> 	* doc/invoke.texi (C Dialect Options): Document -fgnu-tm.

Ok.


r~
Gerald Pfeifer Nov. 5, 2011, 9:02 p.m. UTC | #2
On Thu, 3 Nov 2011, Aldy Hernandez wrote:
> OK for branch?

	* doc/invoke.texi (C Dialect Options): Document -fgnu-tm.

Index: doc/invoke.texi
===================================================================
+When the option @option{-fgnu-tm} is specified, the compiler will
+generate code for the Linux variant of Intel's current Transactional

I assume this ought to be "GNU/Linux variant"?

+Memory ABI specification document (Revision 1.1, May 6 2009).  This is
+an experimental feature whose interface may change in future versions
+of GCC, as the official specification changes.  Please note that not
+all architectures are supported for this feature.

Where can the user find which platforms are supported?

+For more information on GCC's support for transactional memory, see
+the accompanying documentation for @file{libitm}.

Ah, here it is.  How does one find that documentation?

Gerald
Aldy Hernandez Nov. 5, 2011, 9:08 p.m. UTC | #3
Torvald, is this documentation somewhere public whose link we can add to
the committed patch below?  I know the latest draft is not available, but
at least Revision 1.1 which we reference below?

Aldy

> +Memory ABI specification document (Revision 1.1, May 6 2009).  This is
> +an experimental feature whose interface may change in future versions
> +of GCC, as the official specification changes.  Please note that not
> +all architectures are supported for this feature.
>
> Where can the user find which platforms are supported?
>
> +For more information on GCC's support for transactional memory, see
> +the accompanying documentation for @file{libitm}.
>
> Ah, here it is.  How does one find that documentation?
Torvald Riegel Nov. 5, 2011, 9:25 p.m. UTC | #4
On Sat, 2011-11-05 at 14:08 -0700, Aldy Hernandez wrote:
> 
> Torvald, is this documentation somewhere public whose link we can add to
> the committed patch below?  I know the latest draft is not available, but
> at least Revision 1.1 which we reference below?

I don't know of any stable URL. The ABI PDF is linked to from
http://software.intel.com/en-us/articles/intel-c-stm-compiler-prototype-edition/
but I don't think the final URL is supposed to be used for deep linking,
or guaranteed to be stable.

> > +Memory ABI specification document (Revision 1.1, May 6 2009).

This should be Revision 1.0.1, Nov 12 2008. The rev you had there is for
the API / language spec I think.

> This is
> > +an experimental feature whose interface may change in future versions
> > +of GCC, as the official specification changes.  Please note that not
> > +all architectures are supported for this feature.
> >
> > Where can the user find which platforms are supported?

This should be added to libitm too I guess.

> >
> > +For more information on GCC's support for transactional memory, see
> > +the accompanying documentation for @file{libitm}.
> >
> > Ah, here it is.  How does one find that documentation?

Can you put an xref there (or whatever you used for the other link)
instead of the @file{libitm}? Thanks!
Richard Henderson Nov. 5, 2011, 9:38 p.m. UTC | #5
On 11/05/2011 02:25 PM, Torvald Riegel wrote:
> I don't know of any stable URL. The ABI PDF is linked to from
> http://software.intel.com/en-us/articles/intel-c-stm-compiler-prototype-edition/
> but I don't think the final URL is supposed to be used for deep linking,
> or guaranteed to be stable.

We have the GCC wiki.  We can put a copy there and know that it's
going to be stable.


r~
Torvald Riegel Nov. 5, 2011, 9:50 p.m. UTC | #6
On Sat, 2011-11-05 at 14:38 -0700, Richard Henderson wrote:
> On 11/05/2011 02:25 PM, Torvald Riegel wrote:
> > I don't know of any stable URL. The ABI PDF is linked to from
> > http://software.intel.com/en-us/articles/intel-c-stm-compiler-prototype-edition/
> > but I don't think the final URL is supposed to be used for deep linking,
> > or guaranteed to be stable.
> 
> We have the GCC wiki.  We can put a copy there and know that it's
> going to be stable.

IANAL, but I don't see anything in the document's disclaimer/legal
section that would allow us to redistribute this document. IMHO, citing
it by using title, publisher (Intel), and date/revision should be okay
in absence of any better source.

Torvald
Tobias Burnus Nov. 5, 2011, 10:10 p.m. UTC | #7
Richard Henderson wrote:
> We have the GCC wiki.  We can put a copy there and know that it's
> going to be stable.

Jumping on that topic: Is there actually a possibility to "undo" 
attachment deletes in the wiki? I remember someone using an recursive 
"wget" on the wiki, which deleted Graphite PDFs on the way.

The problem is that the Attachment page has, e.g.,

[delete | move | load | show] (2010-01-31 06:10:04, 337.6 KB) 
[[attachment:graphite2y-slides.pdf]]

And the script hit the delete link. I think contrary to "upload" there 
complicated check; I think it is even deleted right away without asking 
"are you sure?" - but it might be that it does and the crawler went over it.

In any case, I failed to find an "undelete" as user - and Sebastian was 
able to upload the files again.

Tobias
diff mbox

Patch

Index: doc/invoke.texi
===================================================================
--- doc/invoke.texi	(revision 180772)
+++ doc/invoke.texi	(working copy)
@@ -1715,6 +1715,18 @@  Program Interface v3.0 @w{@uref{http://w
 implies @option{-pthread}, and thus is only supported on targets that
 have support for @option{-pthread}.
 
+@item -fgnu-tm
+@opindex fgnu-tm
+When the option @option{-fgnu-tm} is specified, the compiler will
+generate code for the Linux variant of Intel's current Transactional
+Memory ABI specification document (Revision 1.1, May 6 2009).  This is
+an experimental feature whose interface may change in future versions
+of GCC, as the official specification changes.  Please note that not
+all architectures are supported for this feature.
+
+For more information on GCC's support for transactional memory, see
+the accompanying documentation for @file{libitm}.
+
 @item -fms-extensions
 @opindex fms-extensions
 Accept some non-standard constructs used in Microsoft header files.