diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-12-26 16:07:14 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-12-27 22:53:11 +0000 |
commit | 70edcf9cf3c3798306803b93fb00270d677af99a (patch) | |
tree | 37cc5a0d0d26a0797d387146ba54ff0700a505f8 /documentation | |
parent | 2c0db14f949a550c6b05c02ee372d8a09269aef7 (diff) | |
download | poky-70edcf9cf3c3798306803b93fb00270d677af99a.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/Makefile | 3 | ||||
-rw-r--r-- | documentation/mega-manual/figures/bb_multiconfig_files.png | bin | 0 -> 19991 bytes | |||
-rw-r--r-- | documentation/mega-manual/figures/bitbake-title.png | bin | 0 -> 5086 bytes | |||
-rw-r--r-- | documentation/mega-manual/mega-manual.xml | 32 | ||||
-rw-r--r-- | documentation/tools/mega-manual.sed | 18 |
5 files changed, 38 insertions, 15 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 093422f69f..1480e14eac 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -269,7 +269,8 @@ TARFILES = mega-manual.html mega-style.css \ | |||
269 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ | 269 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ |
270 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ | 270 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ |
271 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \ | 271 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \ |
272 | figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png | 272 | figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \ |
273 | figures/bb_multiconfig_files.png figures/bitbake-title.png | ||
273 | endif | 274 | endif |
274 | 275 | ||
275 | MANUALS = $(DOC)/$(DOC).html | 276 | 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 index 0000000000..041f06403b --- /dev/null +++ b/documentation/mega-manual/figures/bb_multiconfig_files.png | |||
Binary files differ | |||
diff --git a/documentation/mega-manual/figures/bitbake-title.png b/documentation/mega-manual/figures/bitbake-title.png new file mode 100644 index 0000000000..cb290154da --- /dev/null +++ b/documentation/mega-manual/figures/bitbake-title.png | |||
Binary files differ | |||
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 5ea7052f5a..2c518f9511 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
@@ -12,9 +12,11 @@ | |||
12 | 12 | ||
13 | <abstract> | 13 | <abstract> |
14 | The Yocto Project Mega-Manual is a concatenation of the published | 14 | The Yocto Project Mega-Manual is a concatenation of the published |
15 | Yocto Project HTML manuals for the given release. | 15 | Yocto Project HTML manuals along with the corresponding BitBake |
16 | The manual exists to help users efficiently search for strings | 16 | User Manual for the given release. |
17 | across the entire Yocto Project documentation set. | 17 | The Mega-Manual exists to help users efficiently search for strings |
18 | across the entire Yocto Project documentation set inclusive of | ||
19 | the BitBake User Manual. | ||
18 | </abstract> | 20 | </abstract> |
19 | 21 | ||
20 | <mediaobject> | 22 | <mediaobject> |
@@ -322,6 +324,30 @@ | |||
322 | <xi:include | 324 | <xi:include |
323 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/> | 325 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/> |
324 | 326 | ||
327 | <!-- Includes bitbake-user-manual title image and then bitbake-user-manual chapters --> | ||
328 | |||
329 | <para> | ||
330 | <imagedata fileref="figures/bitbake-title.png" width="100%" align="left" scalefit="1" /> | ||
331 | </para> | ||
332 | |||
333 | <xi:include | ||
334 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml"/> | ||
335 | |||
336 | <xi:include | ||
337 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml"/> | ||
338 | |||
339 | <xi:include | ||
340 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml"/> | ||
341 | |||
342 | <xi:include | ||
343 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml"/> | ||
344 | |||
345 | <xi:include | ||
346 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml"/> | ||
347 | |||
348 | <xi:include | ||
349 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml"/> | ||
350 | |||
325 | </book> | 351 | </book> |
326 | 352 | ||
327 | <!-- | 353 | <!-- |
diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed index 373d3b9b40..79bbeef575 100644 --- a/documentation/tools/mega-manual.sed +++ b/documentation/tools/mega-manual.sed | |||
@@ -1,16 +1,12 @@ | |||
1 | # Processes poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style). | 1 | # Processes bitbake-user-manual (<word>-<word>-<word> style). |
2 | # This style is for manual folders like "yocto-project-qs" and "poky-ref-manual". | 2 | # This style is for manual three-word folders, which currently is only the BitBake User Manual. |
3 | # This is the old way that did it. Can't do that now that we have "bitbake-user-manual" strings | 3 | # We used to have the "yocto-project-qs" and "poky-ref-manual" folders but no longer do. |
4 | # in the mega-manual. | ||
5 | # 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 | 4 | # 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 |
6 | s@"ulink" href="http://www.yoctoproject.org/docs/2.7/yocto-project-qs/yocto-project-qs.html#@"link" href="#@g | 5 | s@"ulink" href="http://www.yoctoproject.org/docs/2.7/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g |
7 | s@"ulink" href="http://www.yoctoproject.org/docs/2.7/poky-ref-manual/poky-ref-manual.html#@"link" href="#@g | ||
8 | 6 | ||
9 | # Processes all other manuals (<word>-<word> style) except for the BitBake User Manual because | 7 | # Processes all other manuals (<word>-<word> style). |
10 | # it is not included in the mega-manual. | ||
11 | # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual"). | 8 | # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual"). |
12 | # This was the one-liner that worked before we introduced the BitBake User Manual, which is | 9 | # Here is the one-liner: |
13 | # not in the mega-manual. | ||
14 | # s@"ulink" href="http://www.yoctoproject.org/docs/2.7/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g | 10 | # s@"ulink" href="http://www.yoctoproject.org/docs/2.7/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g |
15 | 11 | ||
16 | s@"ulink" href="http://www.yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html#@"link" href="#@g | 12 | 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 | |||
25 | 21 | ||
26 | # Process cases where just an external manual is referenced without an id anchor | 22 | # Process cases where just an external manual is referenced without an id anchor |
27 | 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 | 23 | 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 |
28 | 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 | 24 | 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 |
29 | 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 | 25 | 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 |
30 | 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 | 26 | 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 |
31 | 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 | 27 | 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 |