summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/Makefile70
1 files changed, 35 insertions, 35 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 6775120fc7..1ab74fc61a 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -1,69 +1,69 @@
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 documents directory and all figures used
3# in any manuals must be .PNG files and live in the individual book's figures 3# in any manuals must be .PNG files and live in the individual book's figures
4# directory as well as in the figures directory for the mega-manual. 4# 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 Quick Start
11# or the mega-manual (single, large HTML file comprised of all 11# or the mega-manual (single, large HTML file comprised of all
12# Yocto Project manuals). 12# Yocto Project manuals).
13# html: generates an HTML version of a manual. 13# html: generates an HTML version of a manual.
14# tarball: creates a tarball for the doc files. 14# tarball: creates a tarball for the doc files.
15# validate: validates 15# validate: validates
16# publish: pushes generated files to the Yocto Project website 16# publish: pushes generated files to the Yocto Project website
17# clean: removes files 17# clean: removes files
18# 18#
19# The Makefile generates an HTML and PDF version of every document except the 19# The Makefile generates an HTML and PDF version of every document except the
20# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised 20# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised
21# of all the individual Yocto Project manuals. These two manuals are in HTML 21# of all the individual Yocto Project manuals. These two manuals are in HTML
22# form only. The variable DOC indicates the folder name for a given manual. The 22# form only. The variable DOC indicates the folder name for a given manual. The
23# variable VER represents the distro version of the Yocto Release for which the 23# variable VER represents the distro version of the Yocto Release for which the
24# manuals are being generated. The variable BRANCH is used to indicate the 24# manuals are being generated. The variable BRANCH is used to indicate the
25# branch (edison or denzil) and is used only when DOC=dev-manual or 25# branch (edison or denzil) and is used only when DOC=dev-manual or
26# DOC=mega-manual. If you do not specify a BRANCH, the default branch used 26# DOC=mega-manual. If you do not specify a BRANCH, the default branch used
27# will be for the latest Yocto Project release. If you build for either 27# will be for the latest Yocto Project release. If you build for either
28# edison or denzil, you must use BRANCH. You do not need to use BRANCH for 28# edison or denzil, you must use BRANCH. You do not need to use BRANCH for
29# any release beyond denzil. 29# any release beyond denzil.
30# 30#
31# To build a manual, you must invoke Makefile with the DOC argument. If you 31# To build a manual, you must invoke Makefile with the DOC argument. If you
32# are going to publish the manual, then you must invoke Makefile with both the 32# are going to publish the manual, then you must invoke Makefile with both the
33# DOC and the VER argument. Furthermore, if you are building or publishing 33# DOC and the VER argument. Furthermore, if you are building or publishing
34# the edison or denzil versions of the Yocto Poject Development Manual or 34# the edison or denzil versions of the Yocto Poject Development Manual or
35# the mega-manual, you must also use the BRANCH argument. 35# the mega-manual, you must also use the BRANCH argument.
36# 36#
37# Examples: 37# Examples:
38# 38#
39# make DOC=bsp-guide 39# make DOC=bsp-guide
40# make DOC=yocto-project-qs 40# make DOC=yocto-project-qs
41# make pdf DOC=poky-ref-manual 41# make pdf DOC=ref-manual
42# make DOC=dev-manual BRANCH=edison 42# make DOC=dev-manual BRANCH=edison
43# make DOC=mega-manual BRANCH=denzil 43# make DOC=mega-manual BRANCH=denzil
44# 44#
45# The first example generates the HTML and PDF versions of the BSP Guide. 45# The first example generates the HTML and PDF versions of the BSP Guide.
46# The second example generates the HTML version only of the Quick Start. Note that 46# The second example generates the HTML version only of the Quick Start. Note that
47# the Quick Start only has an HTML version available. The third example generates 47# the Quick Start only has an HTML version available. The third example generates
48# both the PDF and HTML versions of the Yocto Project Reference Manual. The 48# both the PDF and HTML versions of the Yocto Project Reference Manual. The
49# fourth example generates both the PDF and HTML 'edison' versions of the YP 49# fourth example generates both the PDF and HTML 'edison' versions of the YP
50# Development Manual. The last exmample generates the HTML version of the 50# Development Manual. The last exmample generates the HTML version of the
51# mega-manual and uses the 'denzil' branch when choosing figures for the 51# mega-manual and uses the 'denzil' branch when choosing figures for the
52# tarball of figures. Any example that does not use the BRANCH argument 52# tarball of figures. Any example that does not use the BRANCH argument
53# builds the current version of the manual set. 53# builds the current version of the manual set.
54# 54#
55# Use the publish target to push the generated manuals to the Yocto Project 55# Use the publish target to push the generated manuals to the Yocto Project
56# website. All files needed for the manual's HTML form are pushed as well as the 56# website. All files needed for the manual's HTML form are pushed as well as the
57# PDF version (if applicable). 57# PDF version (if applicable).
58# Examples: 58# Examples:
59# 59#
60# make publish DOC=bsp-guide VER=1.3 60# make publish DOC=bsp-guide VER=1.3
61# make publish DOC=adt-manual VER=1.3 61# make publish DOC=adt-manual VER=1.3
62# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison 62# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
63# make publish DOC=dev-manual VER=1.2 BRANCH=denzil 63# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
64# 64#
65# The first example publishes the 1.3 version of both the PDF and HTML versions of 65# The first example publishes the 1.3 version of both the PDF and HTML versions of
66# the BSP Guide. The second example publishes the 1.3 version of both the PDF and 66# the BSP Guide. The second example publishes the 1.3 version of both the PDF and
67# HTML versions of the ADT Manual. The third example publishes the PDF and HTML 67# HTML versions of the ADT Manual. The third example publishes the PDF and HTML
68# 'edison' versions of the YP Development Manual. The fourth example publishes 68# 'edison' versions of the YP Development Manual. The fourth example publishes
69# the PDF and HTML 'denzil' versions of the YP Development Manual. 69# the PDF and HTML 'denzil' versions of the YP Development Manual.
@@ -92,7 +92,7 @@ XSLTOPTS = --stringparam html.stylesheet dev-style.css \
92ALLPREQ = html pdf tarball 92ALLPREQ = html pdf tarball
93# 93#
94# Note that the tarfile might produce the "Cannot stat: No such file or directory" error 94# Note that the tarfile might produce the "Cannot stat: No such file or directory" error
95# message for .PNG files that are not present when building a particular branch. The 95# message for .PNG files that are not present when building a particular branch. The
96# list of files is all-inclusive for all branches. Note, if you don't provide a BRANCH 96# list of files is all-inclusive for all branches. Note, if you don't provide a BRANCH
97# option, it defaults to the latest stuff. This would be appropriate for "master" branch. 97# option, it defaults to the latest stuff. This would be appropriate for "master" branch.
98# 98#
@@ -191,7 +191,7 @@ STYLESHEET = $(DOC)/*.css
191 191
192endif 192endif
193 193
194ifeq ($(DOC),poky-ref-manual) 194ifeq ($(DOC),ref-manual)
195XSLTOPTS = --stringparam html.stylesheet ref-style.css \ 195XSLTOPTS = --stringparam html.stylesheet ref-style.css \
196 --stringparam chapter.autolabel 1 \ 196 --stringparam chapter.autolabel 1 \
197 --stringparam appendix.autolabel A \ 197 --stringparam appendix.autolabel A \
@@ -199,7 +199,7 @@ XSLTOPTS = --stringparam html.stylesheet ref-style.css \
199 --stringparam section.label.includes.component.label 1 \ 199 --stringparam section.label.includes.component.label 1 \
200 --xinclude 200 --xinclude
201ALLPREQ = html pdf tarball 201ALLPREQ = html pdf tarball
202TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png \ 202TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
203 figures/buildhistory.png figures/buildhistory-web.png 203 figures/buildhistory.png figures/buildhistory-web.png
204MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf 204MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
205FIGURES = figures 205FIGURES = figures
@@ -259,10 +259,10 @@ else
259 259
260 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd .. 260 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
261endif 261endif
262 262
263html: 263html:
264ifeq ($(DOC),mega-manual) 264ifeq ($(DOC),mega-manual)
265# See http://www.sagehill.net/docbookxsl/HtmlOutput.html 265# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
266 @echo " " 266 @echo " "
267 @echo "******** Building "$(DOC) 267 @echo "******** Building "$(DOC)
268 @echo " " 268 @echo " "
@@ -276,7 +276,7 @@ ifeq ($(DOC),mega-manual)
276 @echo " " 276 @echo " "
277 cd $(DOC); rm mega-manual.html; mv mega-output.html mega-manual.html; cd .. 277 cd $(DOC); rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..
278else 278else
279# See http://www.sagehill.net/docbookxsl/HtmlOutput.html 279# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
280 @echo " " 280 @echo " "
281 @echo "******** Building "$(DOC) 281 @echo "******** Building "$(DOC)
282 @echo " " 282 @echo " "