[libstdc++] Adjust to the new location of the C++ ABI

Submitted by Jonathan Wakely on April 19, 2017, 4:49 p.m.

Details

Message ID 20170419164917.GX3412@redhat.com
State New
Headers show

Commit Message

Jonathan Wakely April 19, 2017, 4:49 p.m.
On 12/04/17 08:37 +1000, Gerald Pfeifer wrote:
>On Thu, 30 Mar 2017, Gerald Pfeifer wrote:
>> (Jonathan, I'm going to take care of the libstdc++/doc links as
>> well in case you wonder.)
>
>Done thusly.
>
>Jonathan, do you think one of the three references in
>doc/xml/manual/abi.xml could be avoided?  That'll make it easier
>next time this document moves. :-}

Well, they go to three different places (or did, before your change).

One link was the the ABI spec, one is to a specific section of the
spec, and one is a bibliography entry linking to the homepage of the
project. I've changed the first one to link to the bibliography entry,
so there are only two now, but I don't think it's am improvement
really. When you click on the link it jumps to the bottom of the
page, but not necessarily to the actual anchor (because it's too near
the bottom of the page).

I certainly don't think we should remove the second one. I
don't want to have a hypertext document that says "see section N of
[biblio.cxxabi]" rather than just hyperlinking directly to it.

>(Also, if you could regenerate and upload the docs?)

Sure.

Committed to trunk.

Patch hide | download patch | download mbox

commit ed7eeb361974a8c64803b617bd760612060cc3ab
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Wed Apr 19 17:45:42 2017 +0100

    Rationalise ABI links in libstdc++ manual
    
    	* doc/xml/manual/abi.xml: Rephrase one of the references to the
    	Itanium C++ ABI.
    	* doc/xml/manual/test.xml: Document DejaGnu 1.5.3 requirement.
    	* doc/html/*: Regenerate.

diff --git a/libstdc++-v3/doc/xml/manual/abi.xml b/libstdc++-v3/doc/xml/manual/abi.xml
index 0e56068..1c816b1 100644
--- a/libstdc++-v3/doc/xml/manual/abi.xml
+++ b/libstdc++-v3/doc/xml/manual/abi.xml
@@ -40,10 +40,9 @@ 
   alignment and in a particular layout, mangling names according to a
   well-defined algorithm, has specific arrangements for the support of
   virtual functions, etc. These details are defined as the compiler
-  Application Binary Interface, or ABI. The GNU C++ compiler uses an
-  industry-standard C++ ABI starting with version 3. Details can be
-  found in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://itanium-cxx-abi.github.io/cxx-abi/">ABI
-  specification</link>.
+  Application Binary Interface, or ABI. From GCC version 3 onwards the
+  GNU C++ compiler uses an industry-standard C++ ABI, the
+  <link linkend="biblio.cxxabi">Itanium C++ ABI</link>.
 </para>
 
 <para>
@@ -1116,7 +1115,7 @@  gcc test.c -g -O2 -L. -lone -ltwo /usr/lib/libstdc++.so.5 /usr/lib/libstdc++.so.
       <title>
 	<link xmlns:xlink="http://www.w3.org/1999/xlink"
 	      xlink:href="https://itanium-cxx-abi.github.io/cxx-abi/">
-	  C++ ABI Summary
+	  Itanium C++ ABI
 	</link>
       </title>
     </biblioentry>
diff --git a/libstdc++-v3/doc/xml/manual/test.xml b/libstdc++-v3/doc/xml/manual/test.xml
index 8ae88b3..7cb7daf 100644
--- a/libstdc++-v3/doc/xml/manual/test.xml
+++ b/libstdc++-v3/doc/xml/manual/test.xml
@@ -563,8 +563,11 @@  cat 27_io/objects/char/3_xin.in | a.out</programlisting>
       the <varname>CXXFLAGS</varname> variable when running
       <command>make</command>, or via options for the DejaGnu test framework
       (described below). The latter approach uses the
-      <option>--target_board</option> option that was shown earlier.
-      For example, to run the tests with <option>-O1 -D_GLIBCXX_ASSERTIONS</option>
+      <option>--target_board</option> option that was shown earlier,
+      but requires DejaGnu version 1.5.3 or newer to work reliably, so that the
+      <literal>dg-options</literal> in the test aren't overridden.
+      For example, to run the tests with
+      <option>-O1 -D_GLIBCXX_ASSERTIONS</option>
       you could use:
 <programlisting>    make RUNTESTFLAGS=--target_board=unix/-O1/-D_GLIBCXX_ASSERTIONS</programlisting>
     </para>