diff mbox series

[libstdc++-,doc] Mislocated </variablelist>

Message ID DB5PR08MB1080A57E08D1E371C707239FE4230@DB5PR08MB1080.eurprd08.prod.outlook.com
State New
Headers show
Series [libstdc++-,doc] Mislocated </variablelist> | expand

Commit Message

Przemyslaw Wirkus Nov. 21, 2017, 3:22 p.m. UTC 
Hello,

Wrong </variablelist> element position causes libstdc++v3 make doc-pdf-docbook
docs generation procedure to fail.

PDF documentation generation for libstdc++v3 is broken for make doc-pdf-docbook
rule. Pdflatex compilation fail because Latex is not correctly generated from
wrongly formatted variablelist elements in XML docs: one varlist entry is
outside section of variablelist elements:

<variablelist>
  <varlistentry/>
  <varlistentry/>
  <varlistentry/>
</variablelist>
  <varlistentry/>

Commit that caused the regression is:

  Author: redi
  Date: Fri Jul 21 16:05:10 2017
  New Revision: 250430
  URL: https://gcc.gnu.org/viewcvs?rev=250430&root=gcc&view=rev

Tested by regenerating libstdc++v3 docs with 'make doc-pdf-docbook'.

OK for trunk?

Kind regards,
Przemyslaw Wirkus

libstdc++-v3/ChangeLog:

2017-11-08  Przemyslaw Wirkus  <przemyslaw.wirkus@arm.com>

	* doc/xml/manual/using.xml (manual.intro.using.macros): Move
	variablelist element at the end of its list.

Comments

Jonathan Wakely Nov. 21, 2017, 3:26 p.m. UTC | #1 
On 21/11/17 15:22 +0000, Przemyslaw Wirkus wrote:
>Hello,
>
>Wrong </variablelist> element position causes libstdc++v3 make doc-pdf-docbook
>docs generation procedure to fail.
>
>PDF documentation generation for libstdc++v3 is broken for make doc-pdf-docbook
>rule. Pdflatex compilation fail because Latex is not correctly generated from
>wrongly formatted variablelist elements in XML docs: one varlist entry is
>outside section of variablelist elements:
>
><variablelist>
>  <varlistentry/>
>  <varlistentry/>
>  <varlistentry/>
></variablelist>
>  <varlistentry/>
>
>Commit that caused the regression is:
>
>  Author: redi
>  Date: Fri Jul 21 16:05:10 2017
>  New Revision: 250430
>  URL: https://gcc.gnu.org/viewcvs?rev=250430&root=gcc&view=rev
>
>Tested by regenerating libstdc++v3 docs with 'make doc-pdf-docbook'.
>
>OK for trunk?

OK, thanks.
Przemyslaw Wirkus Nov. 21, 2017, 4:36 p.m. UTC | #2 
On 21/11/17 15:27 +0000, Jonathan Wakely wrote:
>>OK for trunk?

>OK, thanks.

I don't have privileges to commit. Could you please commit it on my behalf?
Jonathan Wakely Nov. 21, 2017, 6:45 p.m. UTC | #3 
On 21/11/17 16:36 +0000, Przemyslaw Wirkus wrote:
>On 21/11/17 15:27 +0000, Jonathan Wakely wrote:
>>>OK for trunk?
>
>>OK, thanks.
>
>I don't have privileges to commit. Could you please commit it on my behalf?

Done - thanks again for the patch.
diff mbox series

Patch

diff --git a/libstdc++-v3/doc/xml/manual/using.xml b/libstdc++-v3/doc/xml/manual/using.xml
index 6ce29fd30be74fcc5273ec0971a3b72115aaba73..fdbaa5730072189b828ca2ca120ff752f58da2d3 100644
--- a/libstdc++-v3/doc/xml/manual/using.xml
+++ b/libstdc++-v3/doc/xml/manual/using.xml
@@ -989,7 +989,6 @@  g++ -Winvalid-pch -I. -include stdc++.h -H -g -O2 hello.cc -o test.exe
 	enables support for ISO/IEC 29124 Special Math Functions.
       </para>
     </listitem></varlistentry>
-    </variablelist>
 
     <varlistentry><term><code>_GLIBCXX_SANITIZE_VECTOR</code></term>
     <listitem>
@@ -1008,6 +1007,7 @@  g++ -Winvalid-pch -I. -include stdc++.h -H -g -O2 hello.cc -o test.exe
         destroy or modify vectors.
       </para>
     </listitem></varlistentry>
+    </variablelist>
 
   </section>