diff options
| -rw-r--r-- | documentation/Makefile | 84 |
1 files changed, 45 insertions, 39 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 78a2e8e155..873da361c4 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -6,6 +6,9 @@ | |||
| 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 | # all: If you leave off the target then "all" is implied. | ||
| 10 | # You will generate HTML, eclipse help (if applicable), | ||
| 11 | # and a tarball of files. | ||
| 9 | # | 12 | # |
| 10 | # pdf: generates a PDF version of a manual. Not valid for the | 13 | # pdf: generates a PDF version of a manual. Not valid for the |
| 11 | # Quick Start or the mega-manual (single, large HTML file | 14 | # Quick Start or the mega-manual (single, large HTML file |
| @@ -18,11 +21,11 @@ | |||
| 18 | # publish: pushes generated files to the Yocto Project website | 21 | # publish: pushes generated files to the Yocto Project website |
| 19 | # clean: removes files | 22 | # clean: removes files |
| 20 | # | 23 | # |
| 21 | # The Makefile generates an HTML and PDF version of every document except the | 24 | # The Makefile can generate an HTML and PDF version of every document except the |
| 22 | # Yocto Project Quick Start and the single, HTML mega-manual, which is comprised | 25 | # Yocto Project Quick Start and the single, HTML mega-manual, which is comprised |
| 23 | # of all the individual Yocto Project manuals. These two manuals are in HTML | 26 | # of all the individual Yocto Project manuals. You can generate these two manuals |
| 24 | # form only. The variable DOC indicates the folder name for a given manual. The | 27 | # in HTML form only. The variable DOC indicates the folder name for a given manual. |
| 25 | # variable VER represents the distro version of the Yocto Release for which the | 28 | # The variable VER represents the distro version of the Yocto Release for which the |
| 26 | # manuals are being generated. The variable BRANCH is used to indicate the | 29 | # manuals are being generated. The variable BRANCH is used to indicate the |
| 27 | # branch (edison or denzil) and is used only when DOC=dev-manual or | 30 | # branch (edison or denzil) and is used only when DOC=dev-manual or |
| 28 | # DOC=mega-manual. If you do not specify a BRANCH, the default branch used | 31 | # DOC=mega-manual. If you do not specify a BRANCH, the default branch used |
| @@ -39,24 +42,26 @@ | |||
| 39 | # Examples: | 42 | # Examples: |
| 40 | # | 43 | # |
| 41 | # make DOC=bsp-guide | 44 | # make DOC=bsp-guide |
| 42 | # make DOC=yocto-project-qs | 45 | # make html DOC=yocto-project-qs |
| 43 | # make pdf DOC=ref-manual | 46 | # make pdf DOC=ref-manual |
| 44 | # make DOC=dev-manual BRANCH=edison | 47 | # make DOC=dev-manual BRANCH=edison |
| 45 | # make DOC=mega-manual BRANCH=denzil | 48 | # make DOC=mega-manual BRANCH=denzil |
| 46 | # | 49 | # |
| 47 | # The first example generates the HTML and PDF versions of the BSP Guide. | 50 | # The first example generates the HTML and Eclipse help versions of the BSP Guide. |
| 48 | # The second example generates the HTML version only of the Quick Start. Note | 51 | # The second example generates the HTML version only of the Quick Start. Note |
| 49 | # that the Quick Start only has an HTML version available. The third example | 52 | # that the Quick Start only has an HTML version available. So, the |
| 53 | # 'make DOC=yocto-project-qs' command would be equivalent. The third example | ||
| 50 | # generates just the PDF version of the Yocto Project Reference Manual. | 54 | # generates just the PDF version of the Yocto Project Reference Manual. |
| 51 | # The fourth example generates both the PDF and HTML 'edison' versions | 55 | # The fourth example generates the HTML 'edison' version and (if available) |
| 52 | # of the YP Development Manual. The last example generates the HTML version | 56 | # the Eclipse help version of the YP Development Manual. The last example |
| 53 | # of the mega-manual and uses the 'denzil' branch when choosing figures for the | 57 | # generates the HTML version of the mega-manual and uses the 'denzil' |
| 54 | # tarball of figures. Any example that does not use the BRANCH argument | 58 | # branch when choosing figures for the tarball of figures. Any example that does |
| 55 | # builds the current version of the manual set. | 59 | # not use the BRANCH argument builds the current version of the manual set. |
| 56 | # | 60 | # |
| 57 | # Use the publish target to push the generated manuals to the Yocto Project | 61 | # The publish target pushes the generated manuals to the Yocto Project |
| 58 | # website. All files needed for the manual's HTML form are pushed as well as | 62 | # website. Unless you are a developer on the YP team, you will not succeed in |
| 59 | # the PDF version (if applicable). | 63 | # pushing manuals to this server. All files needed for the manual's HTML form are |
| 64 | # pushed as well as applicable Eclipse versions. | ||
| 60 | # | 65 | # |
| 61 | # Examples: | 66 | # Examples: |
| 62 | # | 67 | # |
| @@ -65,19 +70,20 @@ | |||
| 65 | # make publish DOC=dev-manual VER=1.1.1 BRANCH=edison | 70 | # make publish DOC=dev-manual VER=1.1.1 BRANCH=edison |
| 66 | # make publish DOC=dev-manual VER=1.2 BRANCH=denzil | 71 | # make publish DOC=dev-manual VER=1.2 BRANCH=denzil |
| 67 | # | 72 | # |
| 68 | # The first example publishes the 1.3 version of both the PDF and HTML versions | 73 | # The first example publishes the 1.3 version of both the HTML version |
| 69 | # of the BSP Guide. The second example publishes the 1.3 version of both the | 74 | # of the BSP Guide. The second example publishes the 1.3 version of the |
| 70 | # PDF and HTML versions of the ADT Manual. The third example publishes the PDF | 75 | # HTML version of the YP Application Developer's Guide. The third example publishes |
| 71 | # and HTML 'edison' versions of the YP Development Manual. The fourth example | 76 | # the HTML 'edison' versions of the YP Development Manual and, if applicable, the |
| 72 | # publishes the PDF and HTML 'denzil' versions of the YP Development Manual. | 77 | # Eclipse version. The fourth example publishes the HTML 'denzil' version and, |
| 78 | # if applicable, the Eclipse version of the YP Development Manual. | ||
| 73 | # | 79 | # |
| 74 | 80 | ||
| 75 | ifeq ($(DOC),bsp-guide) | 81 | ifeq ($(DOC),bsp-guide) |
| 76 | XSLTOPTS = --xinclude | 82 | XSLTOPTS = --xinclude |
| 77 | ALLPREQ = html pdf eclipse tarball | 83 | ALLPREQ = html eclipse tarball |
| 78 | TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png \ | 84 | TARFILES = bsp-style.css bsp-guide.html figures/bsp-title.png \ |
| 79 | eclipse | 85 | eclipse |
| 80 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 86 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 81 | FIGURES = figures | 87 | FIGURES = figures |
| 82 | STYLESHEET = $(DOC)/*.css | 88 | STYLESHEET = $(DOC)/*.css |
| 83 | 89 | ||
| @@ -85,7 +91,7 @@ endif | |||
| 85 | 91 | ||
| 86 | ifeq ($(DOC),dev-manual) | 92 | ifeq ($(DOC),dev-manual) |
| 87 | XSLTOPTS = --xinclude | 93 | XSLTOPTS = --xinclude |
| 88 | ALLPREQ = html pdf eclipse tarball | 94 | ALLPREQ = html eclipse tarball |
| 89 | # | 95 | # |
| 90 | # Note that the tarfile might produce the "Cannot stat: No such file or | 96 | # Note that the tarfile might produce the "Cannot stat: No such file or |
| 91 | # directory" error message for .PNG files that are not present when building | 97 | # directory" error message for .PNG files that are not present when building |
| @@ -95,7 +101,7 @@ ALLPREQ = html pdf eclipse tarball | |||
| 95 | # | 101 | # |
| 96 | 102 | ||
| 97 | ifeq ($(BRANCH),edison) | 103 | ifeq ($(BRANCH),edison) |
| 98 | TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | 104 | TARFILES = dev-style.css dev-manual.html \ |
| 99 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ | 105 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ |
| 100 | figures/dev-title.png figures/git-workflow.png \ | 106 | figures/dev-title.png figures/git-workflow.png \ |
| 101 | figures/index-downloads.png figures/kernel-dev-flow.png \ | 107 | figures/index-downloads.png figures/kernel-dev-flow.png \ |
| @@ -105,7 +111,7 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | |||
| 105 | figures/source-repos.png figures/yp-download.png \ | 111 | figures/source-repos.png figures/yp-download.png \ |
| 106 | figures/wip.png | 112 | figures/wip.png |
| 107 | else ifeq ($(BRANCH),denzil) | 113 | else ifeq ($(BRANCH),denzil) |
| 108 | TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | 114 | TARFILES = dev-style.css dev-manual.html \ |
| 109 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ | 115 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ |
| 110 | figures/dev-title.png figures/git-workflow.png \ | 116 | figures/dev-title.png figures/git-workflow.png \ |
| 111 | figures/index-downloads.png figures/kernel-dev-flow.png \ | 117 | figures/index-downloads.png figures/kernel-dev-flow.png \ |
| @@ -115,7 +121,7 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | |||
| 115 | figures/source-repos.png figures/yp-download.png \ | 121 | figures/source-repos.png figures/yp-download.png \ |
| 116 | figures/wip.png | 122 | figures/wip.png |
| 117 | else | 123 | else |
| 118 | TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | 124 | TARFILES = dev-style.css dev-manual.html \ |
| 119 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ | 125 | figures/app-dev-flow.png figures/bsp-dev-flow.png \ |
| 120 | figures/dev-title.png figures/git-workflow.png \ | 126 | figures/dev-title.png figures/git-workflow.png \ |
| 121 | figures/index-downloads.png figures/kernel-dev-flow.png \ | 127 | figures/index-downloads.png figures/kernel-dev-flow.png \ |
| @@ -125,7 +131,7 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ | |||
| 125 | eclipse | 131 | eclipse |
| 126 | endif | 132 | endif |
| 127 | 133 | ||
| 128 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 134 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 129 | FIGURES = figures | 135 | FIGURES = figures |
| 130 | STYLESHEET = $(DOC)/*.css | 136 | STYLESHEET = $(DOC)/*.css |
| 131 | 137 | ||
| @@ -239,7 +245,7 @@ endif | |||
| 239 | 245 | ||
| 240 | ifeq ($(DOC),ref-manual) | 246 | ifeq ($(DOC),ref-manual) |
| 241 | XSLTOPTS = --xinclude | 247 | XSLTOPTS = --xinclude |
| 242 | ALLPREQ = html pdf eclipse tarball | 248 | ALLPREQ = html eclipse tarball |
| 243 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ | 249 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ |
| 244 | figures/buildhistory.png figures/buildhistory-web.png eclipse \ | 250 | figures/buildhistory.png figures/buildhistory-web.png eclipse \ |
| 245 | figures/cross-development-toolchains.png figures/layer-input.png \ | 251 | figures/cross-development-toolchains.png figures/layer-input.png \ |
| @@ -249,7 +255,7 @@ TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ | |||
| 249 | figures/patching.png figures/configuration-compile-autoreconf.png \ | 255 | figures/patching.png figures/configuration-compile-autoreconf.png \ |
| 250 | figures/analysis-for-package-splitting.png figures/image-generation.png \ | 256 | figures/analysis-for-package-splitting.png figures/image-generation.png \ |
| 251 | figures/sdk-generation.png | 257 | figures/sdk-generation.png |
| 252 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 258 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 253 | FIGURES = figures | 259 | FIGURES = figures |
| 254 | STYLESHEET = $(DOC)/*.css | 260 | STYLESHEET = $(DOC)/*.css |
| 255 | endif | 261 | endif |
| @@ -257,18 +263,18 @@ endif | |||
| 257 | 263 | ||
| 258 | ifeq ($(DOC),adt-manual) | 264 | ifeq ($(DOC),adt-manual) |
| 259 | XSLTOPTS = --xinclude | 265 | XSLTOPTS = --xinclude |
| 260 | ALLPREQ = html pdf eclipse tarball | 266 | ALLPREQ = html eclipse tarball |
| 261 | TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \ | 267 | TARFILES = adt-manual.html adt-style.css figures/adt-title.png \ |
| 262 | eclipse | 268 | eclipse |
| 263 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 269 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 264 | FIGURES = figures | 270 | FIGURES = figures |
| 265 | STYLESHEET = $(DOC)/*.css | 271 | STYLESHEET = $(DOC)/*.css |
| 266 | endif | 272 | endif |
| 267 | 273 | ||
| 268 | ifeq ($(DOC),profile-manual) | 274 | ifeq ($(DOC),profile-manual) |
| 269 | XSLTOPTS = --xinclude | 275 | XSLTOPTS = --xinclude |
| 270 | ALLPREQ = html pdf eclipse tarball | 276 | ALLPREQ = html eclipse tarball |
| 271 | TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \ | 277 | TARFILES = profile-manual.html profile-manual-style.css \ |
| 272 | figures/profile-title.png figures/kernelshark-all.png \ | 278 | figures/profile-title.png figures/kernelshark-all.png \ |
| 273 | figures/kernelshark-choose-events.png \ | 279 | figures/kernelshark-choose-events.png \ |
| 274 | figures/kernelshark-i915-display.png \ | 280 | figures/kernelshark-i915-display.png \ |
| @@ -295,19 +301,19 @@ TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \ | |||
| 295 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ | 301 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ |
| 296 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \ | 302 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \ |
| 297 | eclipse | 303 | eclipse |
| 298 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 304 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 299 | FIGURES = figures | 305 | FIGURES = figures |
| 300 | STYLESHEET = $(DOC)/*.css | 306 | STYLESHEET = $(DOC)/*.css |
| 301 | endif | 307 | endif |
| 302 | 308 | ||
| 303 | ifeq ($(DOC),kernel-dev) | 309 | ifeq ($(DOC),kernel-dev) |
| 304 | XSLTOPTS = --xinclude | 310 | XSLTOPTS = --xinclude |
| 305 | ALLPREQ = html pdf eclipse tarball | 311 | ALLPREQ = html eclipse tarball |
| 306 | TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css \ | 312 | TARFILES = kernel-dev.html kernel-dev-style.css \ |
| 307 | figures/kernel-dev-title.png \ | 313 | figures/kernel-dev-title.png \ |
| 308 | figures/kernel-architecture-overview.png \ | 314 | figures/kernel-architecture-overview.png \ |
| 309 | eclipse | 315 | eclipse |
| 310 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 316 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
| 311 | FIGURES = figures | 317 | FIGURES = figures |
| 312 | STYLESHEET = $(DOC)/*.css | 318 | STYLESHEET = $(DOC)/*.css |
| 313 | endif | 319 | endif |
