Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openbmc / 316dfdd917bec6a218f431211d28bf8df6b6fb0f / . / import-layers / yocto-poky / documentation / Makefile
blob: e41d5a0f603bf61bfcc45a321025080f29bd003a [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]1# This is a single Makefile to handle all generated Yocto Project documents,
2# which includes the BitBake User Manual and the Toaster User Manual.
3# The Makefile needs to live in the documents directory and all figures used
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#
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]11# Note that the figures for the Yocto Project Development Tasks Manual
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]12# differ depending on the BRANCH being built.
13#
14# The Makefile has these targets:
15# all: If you leave off the target then "all" is implied.
16# You will generate HTML, eclipse help (if applicable),
17# and a tarball of files.
18#
19# pdf: generates a PDF version of a manual. Not valid for the
20# Quick Start or the mega-manual (single, large HTML file
21# comprised of all Yocto Project manuals).
22# html: generates an HTML version of a manual.
23# eclipse: generates an HTML version of a manual that can be used as
24# eclipse help (including necessary metadata files).
25# tarball: creates a tarball for the doc files.
26# validate: validates
27# publish: pushes generated files to the Yocto Project website
28# clean: removes files
29#
30# The Makefile can generate an HTML and PDF version of every document except the
31# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised
32# of all the individual Yocto Project manuals. You can generate these two manuals
33# in HTML form only. The variable DOC indicates the folder name for a given manual.
34# The variable VER represents the distro version of the Yocto Release for which the
35# manuals are being generated. The variable BRANCH is used to indicate the
36# branch (edison or denzil) and is used only when DOC=dev-manual or
37# DOC=mega-manual. If you do not specify a BRANCH, the default branch used
38# will be for the latest Yocto Project release. If you build for either
39# edison or denzil, you must use BRANCH. You do not need to use BRANCH for
40# any release beyond denzil.
41#
42# To build a manual, you must invoke Makefile with the DOC argument. If you
43# are going to publish the manual, then you must invoke Makefile with both the
44# DOC and the VER argument. Furthermore, if you are building or publishing
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]45# the edison or denzil versions of the Yocto Project Development Tasks Manual or
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]46# the mega-manual, you must also use the BRANCH argument.
47#
48# Examples:
49#
50# make DOC=bsp-guide
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]51# make html DOC=brief-yoctoprojectqs
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]52# make pdf DOC=ref-manual
53# make DOC=dev-manual BRANCH=edison
54# make DOC=mega-manual BRANCH=denzil
55#
56# The first example generates the HTML and Eclipse help versions of the BSP Guide.
57# The second example generates the HTML version only of the Quick Start. Note
58# that the Quick Start only has an HTML version available. So, the
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]59# 'make DOC=brief-yoctoprojectqs' command would be equivalent. The third example
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]60# generates just the PDF version of the Yocto Project Reference Manual.
61# The fourth example generates the HTML 'edison' version and (if available)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]62# the Eclipse help version of the YP Development Tasks Manual. The last example
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]63# generates the HTML version of the mega-manual and uses the 'denzil'
64# branch when choosing figures for the tarball of figures. Any example that does
65# not use the BRANCH argument builds the current version of the manual set.
66#
67# The publish target pushes the generated manuals to the Yocto Project
68# website. Unless you are a developer on the YP team, you will not succeed in
69# pushing manuals to this server. All files needed for the manual's HTML form are
70# pushed as well as applicable Eclipse versions.
71#
72# Examples:
73#
74# make publish DOC=bsp-guide VER=1.7
75# make publish DOC=adt-manual VER=1.6
76# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
77# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
78#
79# The first example publishes the 1.7 version of both the PDF and HTML versions of
80# the BSP Guide. The second example publishes the 1.6 version of both the PDF and
81# HTML versions of the ADT Manual. The third example publishes the 1.1.1 version of
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]82# the PDF and HTML YP Development Tasks Manual for the 'edison' branch. The fourth
83# example publishes the 1.2 version of the PDF and HTML YP Development Tasks Manual
84# for the 'denzil' branch.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]85#
86
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]87ifeq ($(DOC),brief-yoctoprojectqs)
88XSLTOPTS = --stringparam html.stylesheet brief-yoctoprojectqs-style.css \
89 --stringparam chapter.autolabel 0 \
90 --stringparam section.autolabel 0 \
91 --stringparam section.label.includes.component.label 0 \
92 --xinclude
93ALLPREQ = html eclipse tarball
94TARFILES = brief-yoctoprojectqs-style.css brief-yoctoprojectqs.html figures/bypqs-title.png \
95 figures/yocto-project-transp.png
96MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
97FIGURES = figures
98STYLESHEET = $(DOC)/*.css
99
100endif
101
102ifeq ($(DOC),overview-manual)
103XSLTOPTS = --xinclude
104ALLPREQ = html eclipse tarball
105TARFILES = overview-manual-style.css overview-manual.html figures/overview-manual-title.png \
106 figures/git-workflow.png figures/source-repos.png figures/index-downloads.png \
107 figures/yp-download.png figures/YP-flow-diagram.png figures/key-dev-elements.png \
108 figures/poky-reference-distribution.png figures/cross-development-toolchains.png \
109 figures/user-configuration.png figures/layer-input.png figures/source-input.png \
110 figures/package-feeds.png figures/patching.png figures/source-fetching.png \
111 figures/configuration-compile-autoreconf.png figures/analysis-for-package-splitting.png \
112 figures/image-generation.png figures/sdk-generation.png figures/images.png \
113 figures/sdk.png \
114 eclipse
115MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
116FIGURES = figures
117STYLESHEET = $(DOC)/*.css
118
119endif
120
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]121ifeq ($(DOC),bsp-guide)
122XSLTOPTS = --xinclude
123ALLPREQ = html eclipse tarball
124TARFILES = bsp-style.css bsp-guide.html figures/bsp-title.png \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]125 figures/bsp-dev-flow.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]126 eclipse
127MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
128FIGURES = figures
129STYLESHEET = $(DOC)/*.css
130
131endif
132
133ifeq ($(DOC),dev-manual)
134XSLTOPTS = --xinclude
135ALLPREQ = html eclipse tarball
136#
137# Note that the tarfile might produce the "Cannot stat: No such file or
138# directory" error message for .PNG files that are not present when building
139# a particular branch. The list of files is all-inclusive for all branches.
140# Note, if you don't provide a BRANCH option, it defaults to the latest stuff.
141# This would be appropriate for "master" branch.
142#
143
144 ifeq ($(BRANCH),edison)
145TARFILES = dev-style.css dev-manual.html \
146 figures/app-dev-flow.png figures/bsp-dev-flow.png \
147 figures/dev-title.png figures/git-workflow.png \
148 figures/index-downloads.png figures/kernel-dev-flow.png \
149 figures/kernel-example-repos-edison.png \
150 figures/kernel-overview-1.png figures/kernel-overview-2.png \
151 figures/kernel-overview-3-edison.png \
152 figures/source-repos.png figures/yp-download.png \
153 figures/wip.png
154 else ifeq ($(BRANCH),denzil)
155TARFILES = dev-style.css dev-manual.html \
156 figures/app-dev-flow.png figures/bsp-dev-flow.png \
157 figures/dev-title.png figures/git-workflow.png \
158 figures/index-downloads.png figures/kernel-dev-flow.png \
159 figures/kernel-example-repos-denzil.png \
160 figures/kernel-overview-1.png figures/kernel-overview-2.png \
161 figures/kernel-overview-3-denzil.png \
162 figures/source-repos.png figures/yp-download.png \
163 figures/wip.png
164 else
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]165TARFILES = dev-style.css dev-manual.html figures/buildhistory-web.png \
166 figures/dev-title.png figures/buildhistory.png \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]167 figures/recipe-workflow.png figures/bitbake-build-flow.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]168 eclipse
169 endif
170
171MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
172FIGURES = figures
173STYLESHEET = $(DOC)/*.css
174
175endif
176
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]177ifeq ($(DOC),mega-manual)
178XSLTOPTS = --stringparam html.stylesheet mega-style.css \
179 --stringparam chapter.autolabel 1 \
180 --stringparam section.autolabel 1 \
181 --stringparam section.label.includes.component.label 1 \
182 --xinclude
183ALLPREQ = html tarball
184
185 ifeq ($(BRANCH),edison)
186TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
187 figures/building-an-image.png \
188 figures/using-a-pre-built-image.png \
189 figures/poky-title.png \
190 figures/adt-title.png figures/bsp-title.png \
191 figures/kernel-title.png figures/kernel-architecture-overview.png \
192 figures/app-dev-flow.png figures/bsp-dev-flow.png \
193 figures/dev-title.png figures/git-workflow.png \
194 figures/index-downloads.png figures/kernel-dev-flow.png \
195 figures/kernel-example-repos-edison.png \
196 figures/kernel-overview-1.png figures/kernel-overview-2.png \
197 figures/kernel-overview-3-edison.png \
198 figures/source-repos.png figures/yp-download.png \
199 figures/wip.png
200 else ifeq ($(BRANCH),denzil)
201TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
202 figures/building-an-image.png \
203 figures/using-a-pre-built-image.png \
204 figures/poky-title.png \
205 figures/adt-title.png figures/bsp-title.png \
206 figures/kernel-title.png figures/kernel-architecture-overview.png \
207 figures/app-dev-flow.png figures/bsp-dev-flow.png \
208 figures/dev-title.png figures/git-workflow.png \
209 figures/index-downloads.png figures/kernel-dev-flow.png \
210 figures/kernel-example-repos-denzil.png \
211 figures/kernel-overview-1.png figures/kernel-overview-2.png \
212 figures/kernel-overview-3-denzil.png \
213 figures/source-repos.png figures/yp-download.png \
214 figures/wip.png
215 else
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]216TARFILES = mega-manual.html mega-style.css \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]217 figures/YP-flow-diagram.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]218 figures/using-a-pre-built-image.png \
219 figures/poky-title.png figures/buildhistory.png \
220 figures/buildhistory-web.png \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]221 figures/sdk-title.png figures/bsp-title.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]222 figures/kernel-dev-title.png figures/kernel-architecture-overview.png \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]223 figures/bsp-dev-flow.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]224 figures/dev-title.png \
225 figures/git-workflow.png figures/index-downloads.png \
226 figures/kernel-dev-flow.png \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]227 figures/kernel-overview-2-generic.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]228 figures/source-repos.png figures/yp-download.png \
229 figures/profile-title.png figures/kernelshark-all.png \
230 figures/kernelshark-choose-events.png \
231 figures/kernelshark-i915-display.png \
232 figures/kernelshark-output-display.png figures/lttngmain0.png \
233 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
234 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
235 figures/perf-probe-do_fork-profile.png \
236 figures/perf-report-cycles-u.png \
237 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
238 figures/perf-wget-busybox-annotate-menu.png \
239 figures/perf-wget-busybox-annotate-udhcpc.png \
240 figures/perf-wget-busybox-debuginfo.png \
241 figures/perf-wget-busybox-dso-zoom.png \
242 figures/perf-wget-busybox-dso-zoom-menu.png \
243 figures/perf-wget-busybox-expanded-stripped.png \
244 figures/perf-wget-flat-stripped.png \
245 figures/perf-wget-g-copy-from-user-expanded-stripped.png \
246 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png \
247 figures/perf-wget-g-copy-to-user-expanded-stripped.png \
248 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png \
249 figures/pybootchartgui-linux-yocto.png \
250 figures/pychart-linux-yocto-rpm.png \
251 figures/pychart-linux-yocto-rpm-nostrip.png \
252 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
253 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
254 figures/cross-development-toolchains.png \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]255 figures/user-configuration.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]256 figures/source-input.png figures/package-feeds.png \
257 figures/layer-input.png figures/images.png figures/sdk.png \
258 figures/source-fetching.png figures/patching.png \
259 figures/configuration-compile-autoreconf.png \
260 figures/analysis-for-package-splitting.png \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]261 figures/image-generation.png figures/key-dev-elements.png\
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]262 figures/sdk-generation.png figures/recipe-workflow.png \
263 figures/build-workspace-directory.png figures/mega-title.png \
264 figures/toaster-title.png figures/hosted-service.png \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]265 figures/simple-configuration.png figures/poky-reference-distribution.png \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]266 figures/compatible-layers.png figures/import-layer.png figures/new-project.png \
267 figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \
268 figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600[diff] [blame]269 figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]270 figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \
271 figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]272 endif
273
274MANUALS = $(DOC)/$(DOC).html
275FIGURES = figures
276STYLESHEET = $(DOC)/*.css
277
278endif
279
280ifeq ($(DOC),ref-manual)
281XSLTOPTS = --xinclude
282ALLPREQ = html eclipse tarball
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]283TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
284 figures/build-workspace-directory.png \
285 eclipse
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]286MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
287FIGURES = figures
288STYLESHEET = $(DOC)/*.css
289endif
290
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]291ifeq ($(DOC),sdk-manual)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]292XSLTOPTS = --xinclude
293ALLPREQ = html eclipse tarball
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]294TARFILES = sdk-manual.html sdk-style.css figures/sdk-title.png \
295 figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \
296 figures/sdk-installed-extensible-sdk-directory.png figures/sdk-devtool-add-flow.png \
297 figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]298 figures/sdk-devtool-upgrade-flow.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]299 eclipse
300MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
301FIGURES = figures
302STYLESHEET = $(DOC)/*.css
303endif
304
305ifeq ($(DOC),profile-manual)
306XSLTOPTS = --xinclude
307ALLPREQ = html eclipse tarball
308TARFILES = profile-manual.html profile-manual-style.css \
309 figures/profile-title.png figures/kernelshark-all.png \
310 figures/kernelshark-choose-events.png \
311 figures/kernelshark-i915-display.png \
312 figures/kernelshark-output-display.png figures/lttngmain0.png \
313 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
314 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
315 figures/perf-probe-do_fork-profile.png \
316 figures/perf-report-cycles-u.png \
317 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
318 figures/perf-wget-busybox-annotate-menu.png \
319 figures/perf-wget-busybox-annotate-udhcpc.png \
320 figures/perf-wget-busybox-debuginfo.png \
321 figures/perf-wget-busybox-dso-zoom.png \
322 figures/perf-wget-busybox-dso-zoom-menu.png \
323 figures/perf-wget-busybox-expanded-stripped.png \
324 figures/perf-wget-flat-stripped.png \
325 figures/perf-wget-g-copy-from-user-expanded-stripped.png \
326 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png \
327 figures/perf-wget-g-copy-to-user-expanded-stripped.png \
328 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png \
329 figures/pybootchartgui-linux-yocto.png \
330 figures/pychart-linux-yocto-rpm.png \
331 figures/pychart-linux-yocto-rpm-nostrip.png \
332 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
333 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
334 eclipse
335MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
336FIGURES = figures
337STYLESHEET = $(DOC)/*.css
338endif
339
340ifeq ($(DOC),kernel-dev)
341XSLTOPTS = --xinclude
342ALLPREQ = html eclipse tarball
343TARFILES = kernel-dev.html kernel-dev-style.css \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]344 figures/kernel-dev-title.png figures/kernel-overview-2-generic.png \
345 figures/kernel-architecture-overview.png figures/kernel-dev-flow.png \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]346 eclipse
347MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
348FIGURES = figures
349STYLESHEET = $(DOC)/*.css
350endif
351
352ifeq ($(DOC),toaster-manual)
353XSLTOPTS = --xinclude
354ALLPREQ = html tarball
355TARFILES = toaster-manual.html toaster-manual-style.css \
356 figures/toaster-title.png figures/simple-configuration.png \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]357 figures/hosted-service.png \
358 figures/compatible-layers.png figures/import-layer.png figures/new-project.png
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500[diff] [blame]359MANUALS = $(DOC)/$(DOC).html
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]360FIGURES = figures
361STYLESHEET = $(DOC)/*.css
362endif
363
364
365##
366# These URI should be rewritten by your distribution's xml catalog to
367# match your locally installed XSL stylesheets.
368XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/1.76.1
369XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
370
371all: $(ALLPREQ)
372
373pdf:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]374ifeq ($(DOC),brief-yoctoprojectqs)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]375 @echo " "
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]376 @echo "ERROR: You cannot generate a PDF file for brief-yoctoprojectqs."
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]377 @echo " "
378
379else ifeq ($(DOC),mega-manual)
380 @echo " "
381 @echo "ERROR: You cannot generate a mega-manual PDF file."
382 @echo " "
383
384else
385
386 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
387endif
388
389html:
390ifeq ($(DOC),mega-manual)
391# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
392 @echo " "
393 @echo "******** Building "$(DOC)
394 @echo " "
395 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
396 @echo " "
397 @echo "******** Using mega-manual.sed to process external links"
398 @echo " "
399 cd $(DOC); sed -f ../tools/mega-manual.sed < mega-manual.html > mega-output.html; cd ..
400 @echo " "
401 @echo "******** Cleaning up transient file mega-output.html"
402 @echo " "
403 cd $(DOC); rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..
404else
405# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
406 @echo " "
407 @echo "******** Building "$(DOC)
408 @echo " "
409 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
410endif
411
412
413eclipse: BASE_DIR = html/$(DOC)/
414
415eclipse: eclipse-generate eclipse-resolve-links
416
417.PHONY : eclipse-generate eclipse-resolve-links
418
419eclipse-generate:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]420ifeq ($(filter $(DOC), overview-manual sdk-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual brief-yoctoprojectqs),)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]421 @echo " "
422 @echo "ERROR: You can only create eclipse documentation"
423 @echo " of the following documentation parts:"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]424 @echo " - overview-manual"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]425 @echo " - sdk-manual"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]426 @echo " - bsp-guide"
427 @echo " - dev-manual"
428 @echo " - kernel-dev"
429 @echo " - profile-manual"
430 @echo " - ref-manual"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400[diff] [blame^]431 @echo " - brief-yoctoprojectqs"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]432 @echo " "
433else
434 @echo " "
435 @echo "******** Building eclipse help of "$(DOC)
436 @echo " "
437 cd $(DOC) && \
438 xsltproc $(XSLTOPTS) \
439 --stringparam base.dir '$(BASE_DIR)' \
440 -o eclipse/$(DOC).html \
441 $(DOC)-eclipse-customization.xsl $(DOC).xml && \
442 mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
443 cp -rf $(FIGURES) eclipse/$(BASE_DIR) && \
444 cd ..;
445
446 $(call modify-eclipse)
447endif
448
449eclipse-resolve-links:
450 @echo " "
451 @echo "******** Using eclipse-help.sed to process external links"
452 @echo " "
453 $(foreach FILE, \
454 $(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \
455 $(shell sed -i -f tools/eclipse-help.sed $(FILE)))
456
457tarball: html
458 @echo " "
459 @echo "******** Creating Tarball of document files"
460 @echo " "
461 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
462
463validate:
464 cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
465
466
467publish:
468 @if test -f $(DOC)/$(DOC).html; \
469 then \
470 echo " "; \
471 echo "******** Publishing "$(DOC)".html"; \
472 echo " "; \
473 scp -r $(MANUALS) $(STYLESHEET) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
474 cd $(DOC); scp -r $(FIGURES) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
475 else \
476 echo " "; \
477 echo $(DOC)".html missing. Generate the file first then try again."; \
478 echo " "; \
479 fi
480
481clean:
482 rm -rf $(MANUALS); rm $(DOC)/$(DOC).tgz;