From 07f37a7fd4b84f996264b7498c55ac333efd4db9 Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Tue, 8 Oct 2019 12:01:44 +0100 Subject: [PATCH] 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. * 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: r276695 --- libstdc++-v3/ChangeLog | 6 ++++++ libstdc++-v3/doc/Makefile.am | 7 ++++++- libstdc++-v3/doc/Makefile.in | 7 ++++++- libstdc++-v3/doc/html/manual/documentation_hacking.html | 7 ++++++- libstdc++-v3/doc/xml/manual/documentation_hacking.xml | 9 ++++++++- 5 files changed, 32 insertions(+), 4 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 31610a47961..7f08a552376 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,11 @@ 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. * doc/html/*: Regenerate. diff --git a/libstdc++-v3/doc/Makefile.am b/libstdc++-v3/doc/Makefile.am index b9aca381b74..9b385edecff 100644 --- a/libstdc++-v3/doc/Makefile.am +++ b/libstdc++-v3/doc/Makefile.am @@ -476,7 +476,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 @@ -545,6 +544,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 5fee1b2d310..6114bff62f6 100644 --- a/libstdc++-v3/doc/Makefile.in +++ b/libstdc++-v3/doc/Makefile.in @@ -977,7 +977,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 @@ -1029,6 +1028,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 6b4592c24a2..0de98a5ff94 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/xml/manual/documentation_hacking.xml b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml index e0990a28516..7db776794c2 100644 --- a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml +++ b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml @@ -807,13 +807,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 -- 2.30.2