summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-11-13 15:23:04 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:57 (GMT)
commitcd31b931e39d9adde8dbbb8de53e097a4c58f50b (patch)
treeeef1c536f401d8e8fb41d693c8b66f69fe4346e6 /documentation
parent430237631e9a480413445646d6c130b4fdb90fff (diff)
downloadpoky-cd31b931e39d9adde8dbbb8de53e097a4c58f50b.tar.gz
documentation: Support files to build Toaster Manual.
Changes to the files that support building out and publishing the Toaster User Manual: * poky.ent - Added a new variable YOCTO_DOCS_TOAST_URL that can be used in other manuals to link to sections with the Toaster User Manual. * Makefile - Added a section of code to build out the Toaster User Manual. Currently, no eclipse support is added as I don't think we want to cross into that development environment with Toaster. (From yocto-docs rev: 35ea6656265d61024d5db36a534a7250f783956a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile39
-rw-r--r--documentation/poky.ent1
2 files changed, 28 insertions, 12 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 3735faf..9957935 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -1,7 +1,13 @@
1# This is a single Makefile to handle all generated Yocto Project documents. 1# This is a single Makefile to handle all generated Yocto Project documents,
2# The Makefile needs to live in the documentation/ directory and all figures 2# which includes the BitBake User Manual and the Toaster User Manual.
3# used in any manuals must be .PNG files and live in the individual book's 3# The Makefile needs to live in the documents directory and all figures used
4# figures/ directory as well as in the figures/ directory for the mega-manual. 4# in any manuals must be .PNG files and live in the individual book's figures
5# directory as well as in the figures directory for the mega-manual.
6#
7# Some manuals are available as linked help through the Eclipse development
8# system. These manuals also include an "eclipse" sub-directory as part of
9# the make process.
10#
5# Note that the figures for the Yocto Project Development Manual 11# Note that the figures for the Yocto Project Development Manual
6# differ depending on the BRANCH being built. 12# differ depending on the BRANCH being built.
7# 13#
@@ -65,17 +71,17 @@
65# 71#
66# Examples: 72# Examples:
67# 73#
68# make publish DOC=bsp-guide VER=1.3 74# make publish DOC=bsp-guide VER=1.7
69# make publish DOC=adt-manual VER=1.3 75# make publish DOC=adt-manual VER=1.6
70# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison 76# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
71# make publish DOC=dev-manual VER=1.2 BRANCH=denzil 77# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
72# 78#
73# The first example publishes the 1.3 version of both the HTML version 79# The first example publishes the 1.7 version of both the PDF and HTML versions of
74# of the BSP Guide. The second example publishes the 1.3 version of the 80# the BSP Guide. The second example publishes the 1.6 version of both the PDF and
75# HTML version of the YP Application Developer's Guide. The third example publishes 81# HTML versions of the ADT Manual. The third example publishes the 1.1.1 version of
76# the HTML 'edison' versions of the YP Development Manual and, if applicable, the 82# the PDF and HTML YP Development Manual for the 'edison' branch. The fourth example
77# Eclipse version. The fourth example publishes the HTML 'denzil' version and, 83# publishes the 1.2 version of the PDF and HTML YP Development Manual for the
78# if applicable, the Eclipse version of the YP Development Manual. 84# 'denzil' branch.
79# 85#
80 86
81ifeq ($(DOC),bsp-guide) 87ifeq ($(DOC),bsp-guide)
@@ -319,6 +325,15 @@ FIGURES = figures
319STYLESHEET = $(DOC)/*.css 325STYLESHEET = $(DOC)/*.css
320endif 326endif
321 327
328ifeq ($(DOC),toaster-manual)
329XSLTOPTS = --xinclude
330ALLPREQ = html pdf tarball
331TARFILES = toaster-manual.html toaster-manual.pdf toaster-manual-style.css figures/toaster-title.png
332MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
333FIGURES = figures
334STYLESHEET = $(DOC)/*.css
335endif
336
322 337
323## 338##
324# These URI should be rewritten by your distribution's xml catalog to 339# These URI should be rewritten by your distribution's xml catalog to
diff --git a/documentation/poky.ent b/documentation/poky.ent
index 6a791db..2d5bd38 100644
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -52,6 +52,7 @@
52<!ENTITY YOCTO_DOCS_PROF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/profile-manual/profile-manual.html"> 52<!ENTITY YOCTO_DOCS_PROF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/profile-manual/profile-manual.html">
53<!ENTITY YOCTO_DOCS_MM_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/mega-manual/mega-manual.html"> 53<!ENTITY YOCTO_DOCS_MM_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/mega-manual/mega-manual.html">
54<!ENTITY YOCTO_DOCS_BB_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/bitbake-user-manual/bitbake-user-manual.html"> 54<!ENTITY YOCTO_DOCS_BB_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/bitbake-user-manual/bitbake-user-manual.html">
55<!ENTITY YOCTO_DOCS_TOAST_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/toaster-manual/toaster-manual.html">
55<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;"> 56<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;">
56<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> 57<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
57<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> 58<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">