Add makefile target to update HTML files in source tree
authorJonathan Wakely <jwakely@redhat.com>
Tue, 8 Oct 2019 11:01:44 +0000 (12:01 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Tue, 8 Oct 2019 11:01:44 +0000 (12:01 +0100)
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
libstdc++-v3/doc/Makefile.am
libstdc++-v3/doc/Makefile.in
libstdc++-v3/doc/html/manual/documentation_hacking.html
libstdc++-v3/doc/xml/manual/documentation_hacking.xml

index 31610a4796108697ce0e826eae2764ced31d1610..7f08a552376dc06c6335d0105d4148e6eac2e2e8 100644 (file)
@@ -1,5 +1,11 @@
 2019-10-08  Jonathan Wakely  <jwakely@redhat.com>
 
+       * 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.
 
index b9aca381b7432f159e7eaaaec8bdca707c3d2d30..9b385edecffc10fd76f60ab59641b1e7b37b8bed 100644 (file)
@@ -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
index 5fee1b2d310d951a009c87282ec05662ae25978e..6114bff62f6d4f53178efd8c9c5a3f8ffe2fdaba 100644 (file)
@@ -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} \
index 6b4592c24a2d082579c21cc676a6a9cc1fb767b0..0de98a5ff940153da206ba5fa8a6798d1edc228c 100644 (file)
       </p><p>
       </p><pre class="screen"><strong class="userinput"><code>make doc-xml-single-docbook</code></strong></pre><p>
       </p><p>
-       Generated files are output into separate sub directores of
+       Generated files are output into separate sub-directores of
        <code class="filename">doc/docbook/</code> in the
        build directory, based on the output format. For instance, the
        HTML docs will be in <code class="filename">doc/docbook/html</code>.
+      </p><p>
+       The </p><pre class="screen">doc-html-docbook-regenerate</pre><p> 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.
       </p><p>
        If the Docbook stylesheets are installed in a custom location,
        one can use the variable <code class="literal">XSL_STYLE_DIR</code> to
index e0990a2851642311993a36d4b343f4fdc30c35e2..7db776794c249e49b5481bbb5827dadbde7b0843 100644 (file)
       </para>
 
       <para>
-       Generated files are output into separate sub directores of
+       Generated files are output into separate sub-directores of
        <filename class="directory">doc/docbook/</filename> in the
        build directory, based on the output format. For instance, the
        HTML docs will be in <filename
        class="directory">doc/docbook/html</filename>.
       </para>
 
+      <para>
+       The <screen>doc-html-docbook-regenerate</screen> 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.
+      </para>
+
       <para>
        If the Docbook stylesheets are installed in a custom location,
        one can use the variable <literal>XSL_STYLE_DIR</literal> to