summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-04 20:12:57 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-07 12:15:36 (GMT)
commit6d5e8360cacdc8169ff3538ab9b0653f37698eda (patch)
tree3fd25cdd23bc961ce645945e615307e1caef9da5 /documentation
parent416433d2ac27d7832794bdda02c6273161af456a (diff)
downloadpoky-6d5e8360cacdc8169ff3538ab9b0653f37698eda.tar.gz
documentation: dev-manual - Created generic figures
Each time the kernel revision is bumped (e.g. 3.2 to 3.4) Some of the figures would be out of date. The reason is they had pathnames that included the release of the kernel. For previous YP releases I was adding logic to the Makefile to be sure to catch the right files dependent on the branch from which the documents were being built. This scheme is not scalable so I decided to make the figures generic by adding a note within the figures explaining the place-holder "<x.x>" as part of a pathname. Thus, three new figures were added to the folders directories of the dev-manual and the mega-manual. Correspondingly, the 'denzil' version of the figures were deleted. I modified the Makefile so that if the BRANCH is not edison or denzil then the generic figure set is used. I have to retain the logic for both edison and denzil to cover the case where a user clones or sets up an edison or denzil repo and then builds out the manuals. Basically, it had to be backwards compatible for releases prior to danny. (From yocto-docs rev: 8283eed4b0b9ec164b87db99c35231f8731ac443) 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/Makefile58
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml2
-rw-r--r--documentation/dev-manual/dev-manual-model.xml4
-rw-r--r--documentation/dev-manual/figures/kernel-example-repos-danny.pngbin25097 -> 0 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-example-repos-generic.pngbin0 -> 28028 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-2-generic.pngbin0 -> 37167 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-2.pngbin34013 -> 0 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-3-denzil.pngbin42285 -> 0 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-3-generic.pngbin0 -> 32586 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-example-repos-danny.pngbin25097 -> 0 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-example-repos-generic.pngbin0 -> 28028 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-2-generic.pngbin0 -> 37167 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-2.pngbin34013 -> 0 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-3-denzil.pngbin42285 -> 0 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-3-generic.pngbin0 -> 32586 bytes
15 files changed, 21 insertions, 43 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 33fcd7a..ea59746 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -24,13 +24,15 @@
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. 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
29# any release beyond denzil.
28# 30#
29# 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
30# 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
31# DOC and the VER argument. If you are building a particular version of the 33# DOC and the VER argument. Furthermore, if you are building or publishing
32# Yocto Project Development Manual or you are building any version of the 34# the edison or denzil versions of the Yocto Poject Development Manual or
33# mega-manual, you must use the DOC and BRANCH arguments. 35# the mega-manual, you must also use the BRANCH argument.
34# 36#
35# Examples: 37# Examples:
36# 38#
@@ -47,7 +49,8 @@
47# 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
48# Development Manual. The last exmample generates the HTML version of the 50# Development Manual. The last exmample generates the HTML version of the
49# 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
50# tarball of figures. 52# tarball of figures. Any example that does not use the BRANCH argument
53# builds the current version of the manual set.
51# 54#
52# 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
53# 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,16 +60,13 @@
57# make publish DOC=bsp-guide VER=1.3 60# make publish DOC=bsp-guide VER=1.3
58# make publish DOC=adt-manual VER=1.3 61# make publish DOC=adt-manual VER=1.3
59# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison 62# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
60# make publish DOC=dev-manual VER=1.2 63# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
61# make publish DOC=mega-manual VER=1.3 BRANCH=denzil
62# 64#
63# The first example publishes the 1.2 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
64# the BSP Guide. The second example publishes the 1.2 version of both the PDF and 66# the BSP Guide. The second example publishes the 1.3 version of both the PDF and
65# 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
66# 'edison' versions of the YP Development Manual. The fourth example publishes 68# 'edison' versions of the YP Development Manual. The fourth example publishes
67# the PDF and HTML 'master' versions of the YP Development Manual. The last 69# the PDF and HTML 'denzil' versions of the YP Development Manual.
68# example publishes the 1.3 version of the mega-manual (HTML-only) and the
69# version generated and published is based on the 'denzil' branch.
70# 70#
71 71
72ifeq ($(DOC),bsp-guide) 72ifeq ($(DOC),bsp-guide)
@@ -115,22 +115,13 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
115 figures/kernel-overview-3-denzil.png \ 115 figures/kernel-overview-3-denzil.png \
116 figures/source-repos.png figures/yp-download.png \ 116 figures/source-repos.png figures/yp-download.png \
117 figures/wip.png 117 figures/wip.png
118 else ifeq ($(BRANCH),danny)
119TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
120 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
121 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
122 figures/kernel-example-repos-danny.png \
123 figures/kernel-overview-1.png figures/kernel-overview-2.png \
124 figures/kernel-overview-3-denzil.png \
125 figures/source-repos.png figures/yp-download.png \
126 figures/wip.png
127 else 118 else
128TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ 119TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
129 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 120 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
130 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 121 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
131 figures/kernel-example-repos-danny.png \ 122 figures/kernel-example-repos-generic.png \
132 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 123 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
133 figures/kernel-overview-3-denzil.png \ 124 figures/kernel-overview-3-generic.png \
134 figures/source-repos.png figures/yp-download.png \ 125 figures/source-repos.png figures/yp-download.png \
135 figures/wip.png 126 figures/wip.png
136 endif 127 endif
@@ -185,19 +176,6 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures
185 figures/kernel-overview-3-denzil.png \ 176 figures/kernel-overview-3-denzil.png \
186 figures/source-repos.png figures/yp-download.png \ 177 figures/source-repos.png figures/yp-download.png \
187 figures/wip.png 178 figures/wip.png
188 else ifeq ($(BRANCH),danny)
189TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
190 figures/using-a-pre-built-image.png \
191 figures/poky-title.png \
192 figures/adt-title.png figures/bsp-title.png \
193 figures/kernel-title.png figures/kernel-architecture-overview.png \
194 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
195 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
196 figures/kernel-example-repos-danny.png \
197 figures/kernel-overview-1.png figures/kernel-overview-2.png \
198 figures/kernel-overview-3-denzil.png \
199 figures/source-repos.png figures/yp-download.png \
200 figures/wip.png
201 else 179 else
202TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ 180TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
203 figures/using-a-pre-built-image.png \ 181 figures/using-a-pre-built-image.png \
@@ -206,9 +184,9 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures
206 figures/kernel-title.png figures/kernel-architecture-overview.png \ 184 figures/kernel-title.png figures/kernel-architecture-overview.png \
207 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ 185 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
208 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ 186 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
209 figures/kernel-example-repos-danny.png \ 187 figures/kernel-example-repos-generic.png \
210 figures/kernel-overview-1.png figures/kernel-overview-2.png \ 188 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
211 figures/kernel-overview-3-denzil.png \ 189 figures/kernel-overview-3-generic.png \
212 figures/source-repos.png figures/yp-download.png \ 190 figures/source-repos.png figures/yp-download.png \
213 figures/wip.png 191 figures/wip.png
214 endif 192 endif
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index cf5fb45..810919f 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -66,7 +66,7 @@
66 </para> 66 </para>
67 67
68 <para> 68 <para>
69 <imagedata fileref="figures/kernel-example-repos-danny.png" width="7in" depth="5in" 69 <imagedata fileref="figures/kernel-example-repos-generic.png" width="7in" depth="5in"
70 align="center" scale="100" /> 70 align="center" scale="100" />
71 </para> 71 </para>
72 72
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index eb36ec0..844e0dc 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -352,7 +352,7 @@
352 </para> 352 </para>
353 353
354 <para> 354 <para>
355 <imagedata fileref="figures/kernel-overview-3-denzil.png" 355 <imagedata fileref="figures/kernel-overview-3-generic.png"
356 width="6in" depth="4in" align="center" scale="100" /> 356 width="6in" depth="4in" align="center" scale="100" />
357 </para> 357 </para>
358 358
@@ -385,7 +385,7 @@
385 </para> 385 </para>
386 386
387 <para> 387 <para>
388 <imagedata fileref="figures/kernel-overview-2.png" 388 <imagedata fileref="figures/kernel-overview-2-generic.png"
389 width="6in" depth="5in" align="center" scale="100" /> 389 width="6in" depth="5in" align="center" scale="100" />
390 </para> 390 </para>
391 391
diff --git a/documentation/dev-manual/figures/kernel-example-repos-danny.png b/documentation/dev-manual/figures/kernel-example-repos-danny.png
deleted file mode 100644
index 01cf47c..0000000
--- a/documentation/dev-manual/figures/kernel-example-repos-danny.png
+++ /dev/null
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-example-repos-generic.png b/documentation/dev-manual/figures/kernel-example-repos-generic.png
new file mode 100644
index 0000000..6cbd58e
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-example-repos-generic.png
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-2-generic.png b/documentation/dev-manual/figures/kernel-overview-2-generic.png
new file mode 100644
index 0000000..bf5ca36
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-overview-2-generic.png
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-2.png b/documentation/dev-manual/figures/kernel-overview-2.png
deleted file mode 100644
index 5fee847..0000000
--- a/documentation/dev-manual/figures/kernel-overview-2.png
+++ /dev/null
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-3-denzil.png b/documentation/dev-manual/figures/kernel-overview-3-denzil.png
deleted file mode 100644
index 5f2ea05..0000000
--- a/documentation/dev-manual/figures/kernel-overview-3-denzil.png
+++ /dev/null
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-3-generic.png b/documentation/dev-manual/figures/kernel-overview-3-generic.png
new file mode 100644
index 0000000..616ca90
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-overview-3-generic.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-example-repos-danny.png b/documentation/mega-manual/figures/kernel-example-repos-danny.png
deleted file mode 100644
index 01cf47c..0000000
--- a/documentation/mega-manual/figures/kernel-example-repos-danny.png
+++ /dev/null
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-example-repos-generic.png b/documentation/mega-manual/figures/kernel-example-repos-generic.png
new file mode 100644
index 0000000..6cbd58e
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-example-repos-generic.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-2-generic.png b/documentation/mega-manual/figures/kernel-overview-2-generic.png
new file mode 100644
index 0000000..bf5ca36
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-overview-2-generic.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-2.png b/documentation/mega-manual/figures/kernel-overview-2.png
deleted file mode 100644
index 5fee847..0000000
--- a/documentation/mega-manual/figures/kernel-overview-2.png
+++ /dev/null
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-3-denzil.png b/documentation/mega-manual/figures/kernel-overview-3-denzil.png
deleted file mode 100644
index 5f2ea05..0000000
--- a/documentation/mega-manual/figures/kernel-overview-3-denzil.png
+++ /dev/null
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-3-generic.png b/documentation/mega-manual/figures/kernel-overview-3-generic.png
new file mode 100644
index 0000000..616ca90
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-overview-3-generic.png
Binary files differ