mega-manual: Updates to support BitBake User Manual

Fixes [YOCTO #12399]

Fixes made to have the BitBake User Manual included in the build
of the mega-manual.  I placed this manual at the end of the
mega-manual.  Following changes made:

 * Makefile - Modified to include two PNG files.  All PNG files
              in a given manual are listed in the area that makes
              the mega-manual so that the tarfile is complete.

 * mega-manual.xml - Updated the front wording to tell the user
              that the BitBake User Manual is included in the
              Mega-Manual.  Also, added a last section to actually
              include the bitbake-title.png file and the *.xml
              files.  Note that I could not add the title figure
              from the same figures folder of the local "bitbake"
              folder.  Would not include in the build.  So, I
              pulled the file from the figures folder of the
              mega-manual, which is what I do for all the other
              book titles used in the mega-manual.

 * mega-manual.sed - Modified to clean out the old stuff that
              had been carried along for older books not
              supported for the release.  Modified to include
              link processing for the newly included BitBake
              User Manual.

 * New Figures - Moved copies of the "bb_multiconfig_files.png"
              and "bitbake-title.png" figures into the
              figures folder of the mega-manual.

(From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/Makefile b/documentation/Makefile
index 093422f69f0cffbdeb741d89f45249e9ba03588e..1480e14eac6d29818d290818a2da4ef6f45f003c 100644 (file)
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -269,7 +269,8 @@ TARFILES = mega-manual.html mega-style.css \
        figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \
        figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \
        figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \
-       figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png
+       figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \
+       figures/bb_multiconfig_files.png figures/bitbake-title.png
        endif
 
 MANUALS = $(DOC)/$(DOC).html

diff --git a/documentation/mega-manual/figures/bb_multiconfig_files.png b/documentation/mega-manual/figures/bb_multiconfig_files.png
new file mode 100644 (file)
index 0000000..041f064
Binary files /dev/null and b/documentation/mega-manual/figures/bb_multiconfig_files.png differ

diff --git a/documentation/mega-manual/figures/bitbake-title.png b/documentation/mega-manual/figures/bitbake-title.png
new file mode 100644 (file)
index 0000000..cb29015
Binary files /dev/null and b/documentation/mega-manual/figures/bitbake-title.png differ

diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml
index 5ea7052f5a1aaf08064bc39448a61e3016427e3e..2c518f951162b51766faa86d3138d4293aa1ee57 100644 (file)
--- a/documentation/mega-manual/mega-manual.xml
+++ b/documentation/mega-manual/mega-manual.xml
@@ -12,9 +12,11 @@
 
         <abstract>
             The Yocto Project Mega-Manual is a concatenation of the published
-            Yocto Project HTML manuals for the given release.
-            The manual exists to help users efficiently search for strings
-            across the entire Yocto Project documentation set.
+            Yocto Project HTML manuals along with the corresponding BitBake
+            User Manual for the given release.
+            The Mega-Manual exists to help users efficiently search for strings
+            across the entire Yocto Project documentation set inclusive of
+            the BitBake User Manual.
         </abstract>
 
         <mediaobject>
@@ -322,6 +324,30 @@
     <xi:include
         xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/>
 
+<!-- Includes bitbake-user-manual title image and then bitbake-user-manual chapters -->
+
+    <para>
+        <imagedata fileref="figures/bitbake-title.png" width="100%" align="left" scalefit="1" />
+    </para>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml"/>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml"/>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml"/>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml"/>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml"/>
+
+    <xi:include
+        xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml"/>
+
 </book>
 
 <!--

diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed
index 373d3b9b40d51ce7810dd5aeb4b40a53e7dfa0ac..79bbeef5758591248d5a3d65c206184ad09e50c0 100644 (file)
--- a/documentation/tools/mega-manual.sed
+++ b/documentation/tools/mega-manual.sed
@@ -1,16 +1,12 @@
-# Processes poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style).
-# This style is for manual folders like "yocto-project-qs" and "poky-ref-manual".
-# This is the old way that did it.  Can't do that now that we have "bitbake-user-manual" strings
-# in the mega-manual.
+# Processes bitbake-user-manual (<word>-<word>-<word> style).
+# This style is for manual three-word folders, which currently is only the BitBake User Manual.
+# We used to have the "yocto-project-qs" and "poky-ref-manual" folders but no longer do.
 # s@"ulink" href="http://www.yoctoproject.org/docs/2.7/[a-z]*-[a-z]*-[a-z]*/[a-z]*-[a-z]*-[a-z]*.html#@"link" href="#@g
-s@"ulink" href="http://www.yoctoproject.org/docs/2.7/yocto-project-qs/yocto-project-qs.html#@"link" href="#@g
-s@"ulink" href="http://www.yoctoproject.org/docs/2.7/poky-ref-manual/poky-ref-manual.html#@"link" href="#@g
+s@"ulink" href="http://www.yoctoproject.org/docs/2.7/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g
 
-# Processes all other manuals (<word>-<word> style) except for the BitBake User Manual because
-# it is not included in the mega-manual.
+# Processes all other manuals (<word>-<word> style).
 # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual").
-# This was the one-liner that worked before we introduced the BitBake User Manual, which is
-# not in the mega-manual.
+# Here is the one-liner:
 # s@"ulink" href="http://www.yoctoproject.org/docs/2.7/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g
 
 s@"ulink" href="http://www.yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html#@"link" href="#@g
@@ -25,7 +21,7 @@ s@"ulink" href="http://www.yoctoproject.org/docs/2.7/toaster-manual/toaster-manu
 
 # Process cases where just an external manual is referenced without an id anchor
 s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/brief-yoctoprojectqs/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build</a>@Yocto Project Quick Build@g
-s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/yocto-project-qs/yocto-project-qs.html" target="_top">Yocto Project Quick Start</a>@Yocto Project Quick Start@g
+s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/bitbake-user-manual/bitbake-user-manual.html" target="_top">BitBake User Manual</a>@BitBake User Manual@g
 s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>@Yocto Project Development Tasks Manual@g
 s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/overview-manual/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual</a>@Yocto project Overview and Concepts Manual@g
 s@<a class="ulink" href="http://www.yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a>@Yocto Project Application Development and the Extensible Software Development Kit (eSDK)@g