summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile183
1 files changed, 110 insertions, 73 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 3bc9a213ee..78a2e8e155 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -1,22 +1,22 @@
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 documents directory and all figures used 2# The Makefile needs to live in the documentation/ directory and all figures
3# in any manuals must be .PNG files and live in the individual book's figures 3# used in any manuals must be .PNG files and live in the individual book's
4# directory as well as in the figures directory for the mega-manual. 4# figures/ directory as well as in the figures/ directory for the mega-manual.
5# Note that the figures for the Yocto Project Development Manual 5# Note that the figures for the Yocto Project Development Manual
6# differ depending on the BRANCH being built. 6# differ depending on the BRANCH being built.
7# 7#
8# The Makefile has these targets: 8# The Makefile has these targets:
9# 9#
10# pdf: generates a PDF version of a manual. Not valid for the Quick Start 10# pdf: generates a PDF version of a manual. Not valid for the
11# or the mega-manual (single, large HTML file comprised of all 11# Quick Start or the mega-manual (single, large HTML file
12# Yocto Project manuals). 12# comprised of all Yocto Project manuals).
13# html: generates an HTML version of a manual. 13# html: generates an HTML version of a manual.
14# eclipse: generates an HTML version of a manual that can be used as 14# eclipse: generates an HTML version of a manual that can be used as
15# eclipse help (including necessary metadata files). 15# eclipse help (including necessary metadata files).
16# tarball: creates a tarball for the doc files. 16# tarball: creates a tarball for the doc files.
17# validate: validates 17# validate: validates
18# publish: pushes generated files to the Yocto Project website 18# publish: pushes generated files to the Yocto Project website
19# clean: removes files 19# clean: removes files
20# 20#
21# The Makefile generates an HTML and PDF version of every document except the 21# The Makefile generates an HTML and PDF version of every document except the
22# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised 22# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised
@@ -33,7 +33,7 @@
33# To build a manual, you must invoke Makefile with the DOC argument. If you 33# To build a manual, you must invoke Makefile with the DOC argument. If you
34# are going to publish the manual, then you must invoke Makefile with both the 34# are going to publish the manual, then you must invoke Makefile with both the
35# DOC and the VER argument. Furthermore, if you are building or publishing 35# DOC and the VER argument. Furthermore, if you are building or publishing
36# the edison or denzil versions of the Yocto Poject Development Manual or 36# the edison or denzil versions of the Yocto Project Development Manual or
37# the mega-manual, you must also use the BRANCH argument. 37# the mega-manual, you must also use the BRANCH argument.
38# 38#
39# Examples: 39# Examples:
@@ -45,18 +45,19 @@
45# make DOC=mega-manual BRANCH=denzil 45# make DOC=mega-manual BRANCH=denzil
46# 46#
47# The first example generates the HTML and PDF versions of the BSP Guide. 47# The first example generates the HTML and PDF versions of the BSP Guide.
48# The second example generates the HTML version only of the Quick Start. Note that 48# The second example generates the HTML version only of the Quick Start. Note
49# the Quick Start only has an HTML version available. The third example generates 49# that the Quick Start only has an HTML version available. The third example
50# both the PDF and HTML versions of the Yocto Project Reference Manual. The 50# generates just the PDF version of the Yocto Project Reference Manual.
51# fourth example generates both the PDF and HTML 'edison' versions of the YP 51# The fourth example generates both the PDF and HTML 'edison' versions
52# Development Manual. The last exmample generates the HTML version of the 52# of the YP Development Manual. The last example generates the HTML version
53# mega-manual and uses the 'denzil' branch when choosing figures for the 53# of the mega-manual and uses the 'denzil' branch when choosing figures for the
54# tarball of figures. Any example that does not use the BRANCH argument 54# tarball of figures. Any example that does not use the BRANCH argument
55# builds the current version of the manual set. 55# builds the current version of the manual set.
56# 56#
57# Use the publish target to push the generated manuals to the Yocto Project 57# Use the publish target to push the generated manuals to the Yocto Project
58# website. All files needed for the manual's HTML form are pushed as well as the 58# website. All files needed for the manual's HTML form are pushed as well as
59# PDF version (if applicable). 59# the PDF version (if applicable).
60#
60# Examples: 61# Examples:
61# 62#
62# make publish DOC=bsp-guide VER=1.3 63# make publish DOC=bsp-guide VER=1.3
@@ -64,11 +65,11 @@
64# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison 65# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
65# make publish DOC=dev-manual VER=1.2 BRANCH=denzil 66# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
66# 67#
67# The first example publishes the 1.3 version of both the PDF and HTML versions of 68# The first example publishes the 1.3 version of both the PDF and HTML versions
68# the BSP Guide. The second example publishes the 1.3 version of both the PDF and 69# of the BSP Guide. The second example publishes the 1.3 version of both the
69# HTML versions of the ADT Manual. The third example publishes the PDF and HTML 70# PDF and HTML versions of the ADT Manual. The third example publishes the PDF
70# 'edison' versions of the YP Development Manual. The fourth example publishes 71# and HTML 'edison' versions of the YP Development Manual. The fourth example
71# the PDF and HTML 'denzil' versions of the YP Development Manual. 72# publishes the PDF and HTML 'denzil' versions of the YP Development Manual.
72# 73#
73 74
74ifeq ($(DOC),bsp-guide) 75ifeq ($(DOC),bsp-guide)
@@ -86,16 +87,18 @@ ifeq ($(DOC),dev-manual)
86XSLTOPTS = --xinclude 87XSLTOPTS = --xinclude
87ALLPREQ = html pdf eclipse tarball 88ALLPREQ = html pdf eclipse tarball
88# 89#
89# Note that the tarfile might produce the "Cannot stat: No such file or directory" error 90# Note that the tarfile might produce the "Cannot stat: No such file or
90# message for .PNG files that are not present when building a particular branch. The 91# directory" error message for .PNG files that are not present when building
91# list of files is all-inclusive for all branches. Note, if you don't provide a BRANCH 92# a particular branch. The list of files is all-inclusive for all branches.
92# option, it defaults to the latest stuff. This would be appropriate for "master" branch. 93# Note, if you don't provide a BRANCH option, it defaults to the latest stuff.
94# This would be appropriate for "master" branch.
93# 95#
94 96
95 ifeq ($(BRANCH),edison) 97 ifeq ($(BRANCH),edison)
96TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ 98TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
97 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 99 figures/app-dev-flow.png figures/bsp-dev-flow.png \
98 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 100 figures/dev-title.png figures/git-workflow.png \
101 figures/index-downloads.png figures/kernel-dev-flow.png \
99 figures/kernel-example-repos-edison.png \ 102 figures/kernel-example-repos-edison.png \
100 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 103 figures/kernel-overview-1.png figures/kernel-overview-2.png \
101 figures/kernel-overview-3-edison.png \ 104 figures/kernel-overview-3-edison.png \
@@ -103,8 +106,9 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
103 figures/wip.png 106 figures/wip.png
104 else ifeq ($(BRANCH),denzil) 107 else ifeq ($(BRANCH),denzil)
105TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ 108TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
106 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 109 figures/app-dev-flow.png figures/bsp-dev-flow.png \
107 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 110 figures/dev-title.png figures/git-workflow.png \
111 figures/index-downloads.png figures/kernel-dev-flow.png \
108 figures/kernel-example-repos-denzil.png \ 112 figures/kernel-example-repos-denzil.png \
109 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 113 figures/kernel-overview-1.png figures/kernel-overview-2.png \
110 figures/kernel-overview-3-denzil.png \ 114 figures/kernel-overview-3-denzil.png \
@@ -112,10 +116,12 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
112 figures/wip.png 116 figures/wip.png
113 else 117 else
114TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ 118TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
115 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 119 figures/app-dev-flow.png figures/bsp-dev-flow.png \
116 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 120 figures/dev-title.png figures/git-workflow.png \
121 figures/index-downloads.png figures/kernel-dev-flow.png \
117 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \ 122 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
118 figures/source-repos.png figures/yp-download.png figures/recipe-workflow.png \ 123 figures/source-repos.png figures/yp-download.png \
124 figures/recipe-workflow.png \
119 eclipse 125 eclipse
120 endif 126 endif
121 127
@@ -146,61 +152,82 @@ XSLTOPTS = --stringparam html.stylesheet mega-style.css \
146ALLPREQ = html tarball 152ALLPREQ = html tarball
147 153
148 ifeq ($(BRANCH),edison) 154 ifeq ($(BRANCH),edison)
149TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ 155TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
156 figures/building-an-image.png \
150 figures/using-a-pre-built-image.png \ 157 figures/using-a-pre-built-image.png \
151 figures/poky-title.png \ 158 figures/poky-title.png \
152 figures/adt-title.png figures/bsp-title.png \ 159 figures/adt-title.png figures/bsp-title.png \
153 figures/kernel-title.png figures/kernel-architecture-overview.png \ 160 figures/kernel-title.png figures/kernel-architecture-overview.png \
154 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 161 figures/app-dev-flow.png figures/bsp-dev-flow.png \
155 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 162 figures/dev-title.png figures/git-workflow.png \
163 figures/index-downloads.png figures/kernel-dev-flow.png \
156 figures/kernel-example-repos-edison.png \ 164 figures/kernel-example-repos-edison.png \
157 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 165 figures/kernel-overview-1.png figures/kernel-overview-2.png \
158 figures/kernel-overview-3-edison.png \ 166 figures/kernel-overview-3-edison.png \
159 figures/source-repos.png figures/yp-download.png \ 167 figures/source-repos.png figures/yp-download.png \
160 figures/wip.png 168 figures/wip.png
161 else ifeq ($(BRANCH),denzil) 169 else ifeq ($(BRANCH),denzil)
162TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ 170TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
171 figures/building-an-image.png \
163 figures/using-a-pre-built-image.png \ 172 figures/using-a-pre-built-image.png \
164 figures/poky-title.png \ 173 figures/poky-title.png \
165 figures/adt-title.png figures/bsp-title.png \ 174 figures/adt-title.png figures/bsp-title.png \
166 figures/kernel-title.png figures/kernel-architecture-overview.png \ 175 figures/kernel-title.png figures/kernel-architecture-overview.png \
167 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 176 figures/app-dev-flow.png figures/bsp-dev-flow.png \
168 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 177 figures/dev-title.png figures/git-workflow.png \
178 figures/index-downloads.png figures/kernel-dev-flow.png \
169 figures/kernel-example-repos-denzil.png \ 179 figures/kernel-example-repos-denzil.png \
170 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 180 figures/kernel-overview-1.png figures/kernel-overview-2.png \
171 figures/kernel-overview-3-denzil.png \ 181 figures/kernel-overview-3-denzil.png \
172 figures/source-repos.png figures/yp-download.png \ 182 figures/source-repos.png figures/yp-download.png \
173 figures/wip.png 183 figures/wip.png
174 else 184 else
175TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ 185TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
186 figures/building-an-image.png \
176 figures/using-a-pre-built-image.png \ 187 figures/using-a-pre-built-image.png \
177 figures/poky-title.png figures/buildhistory.png figures/buildhistory-web.png \ 188 figures/poky-title.png figures/buildhistory.png \
189 figures/buildhistory-web.png \
178 figures/adt-title.png figures/bsp-title.png \ 190 figures/adt-title.png figures/bsp-title.png \
179 figures/kernel-dev-title.png figures/kernel-architecture-overview.png \ 191 figures/kernel-dev-title.png figures/kernel-architecture-overview.png \
180 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 192 figures/app-dev-flow.png figures/bsp-dev-flow.png \
181 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 193 figures/dev-title.png \
194 figures/git-workflow.png figures/index-downloads.png \
195 figures/kernel-dev-flow.png \
182 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \ 196 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
183 figures/source-repos.png figures/yp-download.png \ 197 figures/source-repos.png figures/yp-download.png \
184 figures/profile-title.png figures/kernelshark-all.png \ 198 figures/profile-title.png figures/kernelshark-all.png \
185 figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \ 199 figures/kernelshark-choose-events.png \
200 figures/kernelshark-i915-display.png \
186 figures/kernelshark-output-display.png figures/lttngmain0.png \ 201 figures/kernelshark-output-display.png figures/lttngmain0.png \
187 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ 202 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
188 figures/oprofileui-downloading.png figures/oprofileui-processes.png \ 203 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
189 figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \ 204 figures/perf-probe-do_fork-profile.png \
205 figures/perf-report-cycles-u.png \
190 figures/perf-systemwide.png figures/perf-systemwide-libc.png \ 206 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
191 figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \ 207 figures/perf-wget-busybox-annotate-menu.png \
192 figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \ 208 figures/perf-wget-busybox-annotate-udhcpc.png \
193 figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \ 209 figures/perf-wget-busybox-debuginfo.png \
194 figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \ 210 figures/perf-wget-busybox-dso-zoom.png \
195 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \ 211 figures/perf-wget-busybox-dso-zoom-menu.png \
196 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \ 212 figures/perf-wget-busybox-expanded-stripped.png \
197 figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \ 213 figures/perf-wget-flat-stripped.png \
214 figures/perf-wget-g-copy-from-user-expanded-stripped.png \
215 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png \
216 figures/perf-wget-g-copy-to-user-expanded-stripped.png \
217 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png \
218 figures/pybootchartgui-linux-yocto.png \
219 figures/pychart-linux-yocto-rpm.png \
220 figures/pychart-linux-yocto-rpm-nostrip.png \
198 figures/sched-wakeup-profile.png figures/sysprof-callers.png \ 221 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
199 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \ 222 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
200 figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \ 223 figures/cross-development-toolchains.png \
201 figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \ 224 figures/yocto-environment-ref.png figures/user-configuration.png \
202 figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ 225 figures/source-input.png figures/package-feeds.png \
203 figures/analysis-for-package-splitting.png figures/image-generation.png \ 226 figures/layer-input.png figures/images.png figures/sdk.png \
227 figures/source-fetching.png figures/patching.png \
228 figures/configuration-compile-autoreconf.png \
229 figures/analysis-for-package-splitting.png \
230 figures/image-generation.png \
204 figures/sdk-generation.png figures/recipe-workflow.png 231 figures/sdk-generation.png figures/recipe-workflow.png
205 endif 232 endif
206 233
@@ -243,19 +270,28 @@ XSLTOPTS = --xinclude
243ALLPREQ = html pdf eclipse tarball 270ALLPREQ = html pdf eclipse tarball
244TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \ 271TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \
245 figures/profile-title.png figures/kernelshark-all.png \ 272 figures/profile-title.png figures/kernelshark-all.png \
246 figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \ 273 figures/kernelshark-choose-events.png \
274 figures/kernelshark-i915-display.png \
247 figures/kernelshark-output-display.png figures/lttngmain0.png \ 275 figures/kernelshark-output-display.png figures/lttngmain0.png \
248 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ 276 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
249 figures/oprofileui-downloading.png figures/oprofileui-processes.png \ 277 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
250 figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \ 278 figures/perf-probe-do_fork-profile.png \
279 figures/perf-report-cycles-u.png \
251 figures/perf-systemwide.png figures/perf-systemwide-libc.png \ 280 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
252 figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \ 281 figures/perf-wget-busybox-annotate-menu.png \
253 figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \ 282 figures/perf-wget-busybox-annotate-udhcpc.png \
254 figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \ 283 figures/perf-wget-busybox-debuginfo.png \
255 figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \ 284 figures/perf-wget-busybox-dso-zoom.png \
256 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \ 285 figures/perf-wget-busybox-dso-zoom-menu.png \
257 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \ 286 figures/perf-wget-busybox-expanded-stripped.png \
258 figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \ 287 figures/perf-wget-flat-stripped.png \
288 figures/perf-wget-g-copy-from-user-expanded-stripped.png \
289 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png \
290 figures/perf-wget-g-copy-to-user-expanded-stripped.png \
291 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png \
292 figures/pybootchartgui-linux-yocto.png \
293 figures/pychart-linux-yocto-rpm.png \
294 figures/pychart-linux-yocto-rpm-nostrip.png \
259 figures/sched-wakeup-profile.png figures/sysprof-callers.png \ 295 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
260 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \ 296 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
261 eclipse 297 eclipse
@@ -267,7 +303,8 @@ endif
267ifeq ($(DOC),kernel-dev) 303ifeq ($(DOC),kernel-dev)
268XSLTOPTS = --xinclude 304XSLTOPTS = --xinclude
269ALLPREQ = html pdf eclipse tarball 305ALLPREQ = html pdf eclipse tarball
270TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png \ 306TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css \
307 figures/kernel-dev-title.png \
271 figures/kernel-architecture-overview.png \ 308 figures/kernel-architecture-overview.png \
272 eclipse 309 eclipse
273MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse 310MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
@@ -278,7 +315,7 @@ endif
278 315
279## 316##
280# These URI should be rewritten by your distribution's xml catalog to 317# These URI should be rewritten by your distribution's xml catalog to
281# match your localy installed XSL stylesheets. 318# match your locally installed XSL stylesheets.
282XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current 319XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
283XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl 320XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
284 321