Patchwork 14/n: trans-mem: compiler documentation

login
register
mail settings
Submitter Aldy Hernandez
Date Nov. 4, 2011, 12:22 a.m.
Message ID <4EB33045.2050603@redhat.com>
Download mbox | patch
Permalink /patch/123535/
State New
Headers show

Comments

Aldy Hernandez - Nov. 4, 2011, 12:22 a.m.
>> I thought so too, but couldn't find how.  Libitm is in another directory
>> (libitm/libitm.texi).  Does anyone know how to do this?
>
> When installed, all info files are presumed to go in one directory, HTML
> files in parallel directories, etc.; you use the five-argument form of
> @xref with "libitm" as the fourth argument.
>

Thank you Joseph.

I made it behave like:

	@section References for other languages

	@xref{Top, GNAT Reference Manual, About This Guide, gnat_rm,
	GNAT Reference Manual}, for information on standard
	conformance and compatibility of the Ada compiler.

elsewhere in standards.texi.

OK for branch?

	* doc/invoke.texi: Add xref for libitm.
Joseph S. Myers - Nov. 4, 2011, 12:30 a.m.
On Thu, 3 Nov 2011, Aldy Hernandez wrote:

> > > I thought so too, but couldn't find how.  Libitm is in another directory
> > > (libitm/libitm.texi).  Does anyone know how to do this?
> > 
> > When installed, all info files are presumed to go in one directory, HTML
> > files in parallel directories, etc.; you use the five-argument form of
> > @xref with "libitm" as the fourth argument.
> > 
> 
> Thank you Joseph.
> 
> I made it behave like:
> 
> 	@section References for other languages
> 
> 	@xref{Top, GNAT Reference Manual, About This Guide, gnat_rm,
> 	GNAT Reference Manual}, for information on standard
> 	conformance and compatibility of the Ada compiler.
> 
> elsewhere in standards.texi.
> 
> OK for branch?

OK with me.
Aldy Hernandez - Nov. 4, 2011, 12:52 a.m.
On 11/03/11 19:30, Joseph S. Myers wrote:
> On Thu, 3 Nov 2011, Aldy Hernandez wrote:
>
>>>> I thought so too, but couldn't find how.  Libitm is in another directory
>>>> (libitm/libitm.texi).  Does anyone know how to do this?
>>>
>>> When installed, all info files are presumed to go in one directory, HTML
>>> files in parallel directories, etc.; you use the five-argument form of
>>> @xref with "libitm" as the fourth argument.
>>>
>>
>> Thank you Joseph.
>>
>> I made it behave like:
>>
>> 	@section References for other languages
>>
>> 	@xref{Top, GNAT Reference Manual, About This Guide, gnat_rm,
>> 	GNAT Reference Manual}, for information on standard
>> 	conformance and compatibility of the Ada compiler.
>>
>> elsewhere in standards.texi.
>>
>> OK for branch?
>
> OK with me.
>

Ok, committed to branch.

Thanks for the review.

Patch

Index: doc/invoke.texi
===================================================================
--- doc/invoke.texi	(revision 180836)
+++ doc/invoke.texi	(working copy)
@@ -1724,8 +1724,9 @@  an experimental feature whose interface
  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}.
+For more information on GCC's support for transactional memory,
+@xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
+Transactional Memory Library}.

  @item -fms-extensions
  @opindex fms-extensions