From: Jonathan Wakely Date: Thu, 24 Oct 2019 15:30:57 +0000 (+0100) Subject: Add makefile target to update HTML files in source tree X-Git-Tag: releases/gcc-7.5.0~46 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bd6377aef168a539f6e7ad32e826dedf1ceb1ffd;p=thirdparty%2Fgcc.git Add makefile target to update HTML files in source tree Also remove the creation of the html/ext sub-directory, which has been unused since revision r245258. Backport from mainline 2019-10-08 Jonathan Wakely * doc/Makefile.am (doc-html-docbook-regenerate): New target. (${docbook_outdir}/html): Do not create unused 'html/ext' directory. * doc/Makefile.in: Regenerate. * doc/xml/manual/documentation_hacking.xml: Document new target. * doc/html/*: Regenerate. From-SVN: r277413 --- diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index f10755a510ec..b51beb4c28eb 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,14 @@ 2019-10-24 Jonathan Wakely + Backport from mainline + 2019-10-08 Jonathan Wakely + + * doc/Makefile.am (doc-html-docbook-regenerate): New target. + (${docbook_outdir}/html): Do not create unused 'html/ext' directory. + * doc/Makefile.in: Regenerate. + * doc/xml/manual/documentation_hacking.xml: Document new target. + * doc/html/*: Regenerate. + * doc/xml/manual/allocator.xml: Use archived copy of CUJ article. Backport from mainline diff --git a/libstdc++-v3/doc/Makefile.am b/libstdc++-v3/doc/Makefile.am index 7d0c52d96b5b..702d887b74b7 100644 --- a/libstdc++-v3/doc/Makefile.am +++ b/libstdc++-v3/doc/Makefile.am @@ -477,7 +477,6 @@ ${docbook_outdir}/fo: ${docbook_outdir}/html: mkdir -p ${docbook_outdir}/html - mkdir -p ${docbook_outdir}/html/ext mkdir -p ${docbook_outdir}/html/images mkdir -p ${docbook_outdir}/html/manual @@ -546,6 +545,12 @@ stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-docbook: stamp-html-docbook-data +# Generate the HTML pages and copy them back to the source tree. +doc-html-docbook-regenerate: doc-html-docbook + $(INSTALL_DATA) ${docbook_outdir}/html/*.html ${top_srcdir}/doc/html + $(INSTALL_DATA) ${docbook_outdir}/html/images/* ${top_srcdir}/doc/html/images + $(INSTALL_DATA) ${docbook_outdir}/html/manual/*.html ${top_srcdir}/doc/html/manual + # HTML, all one page # NB: Have to generate customization XSL for UTF-8 output. manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html diff --git a/libstdc++-v3/doc/Makefile.in b/libstdc++-v3/doc/Makefile.in index c4991e92916a..c98c42fce98f 100644 --- a/libstdc++-v3/doc/Makefile.in +++ b/libstdc++-v3/doc/Makefile.in @@ -926,7 +926,6 @@ ${docbook_outdir}/fo: ${docbook_outdir}/html: mkdir -p ${docbook_outdir}/html - mkdir -p ${docbook_outdir}/html/ext mkdir -p ${docbook_outdir}/html/images mkdir -p ${docbook_outdir}/html/manual @@ -978,6 +977,12 @@ stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html $(STAMP) stamp-html-docbook doc-html-docbook: stamp-html-docbook-data + +# Generate the HTML pages and copy them back to the source tree. +doc-html-docbook-regenerate: doc-html-docbook + $(INSTALL_DATA) ${docbook_outdir}/html/*.html ${top_srcdir}/doc/html + $(INSTALL_DATA) ${docbook_outdir}/html/images/* ${top_srcdir}/doc/html/images + $(INSTALL_DATA) ${docbook_outdir}/html/manual/*.html ${top_srcdir}/doc/html/manual stamp-html-single-docbook: $(xml_sources) ${docbook_outdir}/html @echo "Generating html single file..." $(XSLTPROC) $(XSLT_PARAM) $(XSLT_FLAGS) -o ${manual_html} \ diff --git a/libstdc++-v3/doc/html/manual/documentation_hacking.html b/libstdc++-v3/doc/html/manual/documentation_hacking.html index 274cdaca908e..d96e7fe09155 100644 --- a/libstdc++-v3/doc/html/manual/documentation_hacking.html +++ b/libstdc++-v3/doc/html/manual/documentation_hacking.html @@ -381,10 +381,15 @@ 

make doc-xml-single-docbook

- Generated files are output into separate sub directores of + Generated files are output into separate sub-directores of doc/docbook/ in the build directory, based on the output format. For instance, the HTML docs will be in doc/docbook/html. +

+ The 

doc-html-docbook-regenerate

target will generate + the HTML files and copy them back to the libstdc++ source tree. + This can be used to update the HTML files that are checked in to + version control.

If the Docbook stylesheets are installed in a custom location, one can use the variable XSL_STYLE_DIR to diff --git a/libstdc++-v3/doc/html/manual/memory.html b/libstdc++-v3/doc/html/manual/memory.html index b7c948060319..72e73c6b5faa 100644 --- a/libstdc++-v3/doc/html/manual/memory.html +++ b/libstdc++-v3/doc/html/manual/memory.html @@ -314,13 +314,13 @@ . isoc++_1998 20.4 Memory.

- + The Standard Librarian: What Are Allocators Good For? - - . Matt Austern. + + . Matt Austern. C/C++ Users Journal - .

- + . 2000-12.

+ The Hoard Memory Allocator . Emery Berger.

diff --git a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml index 8ab9e870542c..9991976d4354 100644 --- a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml +++ b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml @@ -805,13 +805,20 @@ - Generated files are output into separate sub directores of + Generated files are output into separate sub-directores of doc/docbook/ in the build directory, based on the output format. For instance, the HTML docs will be in doc/docbook/html. + + The doc-html-docbook-regenerate target will generate + the HTML files and copy them back to the libstdc++ source tree. + This can be used to update the HTML files that are checked in to + version control. + + If the Docbook stylesheets are installed in a custom location, one can use the variable XSL_STYLE_DIR to