summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/Makefile62
1 files changed, 44 insertions, 18 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 02fe0a3e95..7cf1c6727e 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -1,48 +1,61 @@
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. 4# directory. Note that the figures for the Yocto Project Development Manual
5# differ between the 'master' and 'edison' branches.
5# 6#
6# The Makefile has these targets: 7# The Makefile has these targets:
7# 8#
8# pdf: generates a PDF version of a manual. Not valid for the Quick Start 9# pdf: generates a PDF version of a manual. Not valid for the Quick Start
9# html: generates an HTML version of a manual. 10# html: generates an HTML version of a manual.
10# tarball: creates a tarball for the doc files. 11# tarball: creates a tarball for the doc files.
11# validate: validates 12# validate: validates
12# publish: pushes generated files to the Yocto Project website 13# publish: pushes generated files to the Yocto Project website
13# clean: removes files 14# clean: removes files
14# 15#
15# The Makefile generates an HTML and PDF version of every document except the 16# The Makefile generates an HTML and PDF version of every document except the
16# Yocto Project Quick Start. The Quick Start is in HTML form only. The variable 17# Yocto Project Quick Start. The Quick Start is in HTML form only. The variable
17# The command-line argument DOC represents the folder name in which a particular 18# DOC is used to indicate the folder name for a given manual. The variable
18# document is stored. The command-line argument VER represents the distro 19# VER represents the distro version of the Yocto Release for which the manuals
19# version of the Yocto Release for which the manuals are being generated. 20# are being generated. The variable BRANCH is used to indicate the 'edison'
21# branch and is used only when DOC=dev-manual (making the YP Development
22# Manual).
23#
20# To build the HTML and PDF versions of the manual you must invoke the Makefile 24# To build the HTML and PDF versions of the manual you must invoke the Makefile
21# with the DOC argument. If you are going to publish the manual then you 25# with the DOC argument. If you are going to publish the manual then you
22# you must invoke the Makefile with both the DOC and the VER argument. 26# you must invoke the Makefile with both the DOC and the VER argument.
27# If you are building the 'edison' version of the YP DEvelopment Manual then
28# you must use the DOC and BRANCH arguments.
23# 29#
24# Examples: 30# Examples:
25# 31#
26# make DOC=bsp-guide 32# make DOC=bsp-guide
27# make DOC=yocto-project-qs 33# make DOC=yocto-project-qs
28# make pdf DOC=poky-ref-manual 34# make pdf DOC=poky-ref-manual
35# make DOC=dev-manual BRANCH=edison
29# 36#
30# The first example generates the HTML and PDF versions of the BSP Guide. 37# The first example generates the HTML and PDF versions of the BSP Guide.
31# The second example generates the HTML version only of the Quick Start. Note that 38# The second example generates the HTML version only of the Quick Start. Note that
32# the Quick Start only has an HTML version available. The third example generates 39# the Quick Start only has an HTML version available. The third example generates
33# both the PDF and HTML versions of the Yocto Project Reference Manual. 40# both the PDF and HTML versions of the Yocto Project Reference Manual. The
41# last example generates both the PDF and HTML 'edison' versions of the YP
42# Development Manual.
34# 43#
35# Use the publish target to push the generated manuals to the Yocto Project 44# Use the publish target to push the generated manuals to the Yocto Project
36# website. All files needed for the manual's HTML form are pushed as well as the 45# website. All files needed for the manual's HTML form are pushed as well as the
37# PDF version (if applicable). 46# PDF version (if applicable).
38# Examples: 47# Examples:
39# 48#
40# make publish DOC=bsp-guide VER=1.1 49# make publish DOC=bsp-guide VER=1.2
41# make publish DOC=adt-manual VER=1.1 50# make publish DOC=adt-manual VER=1.2
51# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
52# make publish DOC=dev-manual VER=1.2
42# 53#
43# The first example publishes the 1.1 version of both the PDF and HTML versions of 54# The first example publishes the 1.2 version of both the PDF and HTML versions of
44# the BSP Guide. The second example publishes the 1.1 version of both the PDF and 55# the BSP Guide. The second example publishes the 1.2 version of both the PDF and
45# HTML versions of the ADT Manual. 56# HTML versions of the ADT Manual. The third example publishes the PDF and HTML
57# 'edison' versions of the YP Development Manual. Finally, the last example publishes
58# the PDF and HTML 'master' versions of the YP Development Manual.
46# 59#
47 60
48ifeq ($(DOC),bsp-guide) 61ifeq ($(DOC),bsp-guide)
@@ -71,14 +84,27 @@ ALLPREQ = html pdf tarball
71# message for .PNG files that are not present when building a particular branch. The 84# message for .PNG files that are not present when building a particular branch. The
72# list of files is all-inclusive for all branches. 85# list of files is all-inclusive for all branches.
73# 86#
87
88 ifeq ($(BRANCH),edison)
74TARFILES = style.css dev-manual.html dev-manual.pdf \ 89TARFILES = style.css dev-manual.html dev-manual.pdf \
75 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 90 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
76 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 91 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
77 figures/kernel-example-repos.png figures/kernel-example-repos-edison.png \ 92 figures/kernel-example-repos-edison.png \
78 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 93 figures/kernel-overview-1.png figures/kernel-overview-2.png \
79 figures/kernel-overview-3.png figures/kernel-overview-3-edison.png \ 94 figures/kernel-overview-3-edison.png \
80 figures/source-repos.png figures/yp-download.png \ 95 figures/source-repos.png figures/yp-download.png \
81 figures/wip.png 96 figures/wip.png
97 else
98TARFILES = style.css dev-manual.html dev-manual.pdf \
99 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
100 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
101 figures/kernel-example-repos.png \
102 figures/kernel-overview-1.png figures/kernel-overview-2.png \
103 figures/kernel-overview-3.png \
104 figures/source-repos.png figures/yp-download.png \
105 figures/wip.png
106 endif
107
82MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf 108MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
83FIGURES = figures 109FIGURES = figures
84STYLESHEET = $(DOC)/*.css 110STYLESHEET = $(DOC)/*.css