diff options
| -rw-r--r-- | documentation/Makefile | 122 |
1 files changed, 32 insertions, 90 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 1480e14eac..accf23414f 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -4,24 +4,17 @@ | |||
| 4 | # in any manuals must be .PNG files and live in the individual book's figures | 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. | 5 | # directory as well as in the figures directory for the mega-manual. |
| 6 | # | 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 | # | ||
| 11 | # Note that the figures for the Yocto Project Development Tasks Manual | 7 | # Note that the figures for the Yocto Project Development Tasks Manual |
| 12 | # differ depending on the BRANCH being built. | 8 | # differ depending on the BRANCH being built. |
| 13 | # | 9 | # |
| 14 | # The Makefile has these targets: | 10 | # The Makefile has these targets: |
| 15 | # all: If you leave off the target then "all" is implied. | 11 | # all: If you leave off the target then "all" is implied. |
| 16 | # You will generate HTML, eclipse help (if applicable), | 12 | # You will generate HTML and a tarball of files. |
| 17 | # and a tarball of files. | ||
| 18 | # | 13 | # |
| 19 | # pdf: generates a PDF version of a manual. Not valid for the | 14 | # pdf: generates a PDF version of a manual. Not valid for the |
| 20 | # Quick Start or the mega-manual (single, large HTML file | 15 | # Quick Start or the mega-manual (single, large HTML file |
| 21 | # comprised of all Yocto Project manuals). | 16 | # comprised of all Yocto Project manuals). |
| 22 | # html: generates an HTML version of a manual. | 17 | # 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. | 18 | # tarball: creates a tarball for the doc files. |
| 26 | # validate: validates | 19 | # validate: validates |
| 27 | # publish: pushes generated files to the Yocto Project website | 20 | # publish: pushes generated files to the Yocto Project website |
| @@ -53,13 +46,13 @@ | |||
| 53 | # make DOC=dev-manual BRANCH=edison | 46 | # make DOC=dev-manual BRANCH=edison |
| 54 | # make DOC=mega-manual BRANCH=denzil | 47 | # make DOC=mega-manual BRANCH=denzil |
| 55 | # | 48 | # |
| 56 | # The first example generates the HTML and Eclipse help versions of the BSP Guide. | 49 | # The first example generates the HTML version of the BSP Guide. |
| 57 | # The second example generates the HTML version only of the Quick Start. Note | 50 | # 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 | 51 | # that the Quick Start only has an HTML version available. So, the |
| 59 | # 'make DOC=brief-yoctoprojectqs' command would be equivalent. The third example | 52 | # 'make DOC=brief-yoctoprojectqs' command would be equivalent. The third example |
| 60 | # generates just the PDF version of the Yocto Project Reference Manual. | 53 | # generates just the PDF version of the Yocto Project Reference Manual. |
| 61 | # The fourth example generates the HTML 'edison' version and (if available) | 54 | # The fourth example generates the HTML 'edison' version of the YP Development |
| 62 | # the Eclipse help version of the YP Development Tasks Manual. The last example | 55 | # Tasks Manual. The last example |
| 63 | # generates the HTML version of the mega-manual and uses the 'denzil' | 56 | # 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 | 57 | # 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. | 58 | # not use the BRANCH argument builds the current version of the manual set. |
| @@ -67,7 +60,7 @@ | |||
| 67 | # The publish target pushes the generated manuals to the Yocto Project | 60 | # 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 | 61 | # 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 | 62 | # pushing manuals to this server. All files needed for the manual's HTML form are |
| 70 | # pushed as well as applicable Eclipse versions. | 63 | # pushed. |
| 71 | # | 64 | # |
| 72 | # Examples: | 65 | # Examples: |
| 73 | # | 66 | # |
| @@ -90,10 +83,10 @@ XSLTOPTS = --stringparam html.stylesheet brief-yoctoprojectqs-style.css \ | |||
| 90 | --stringparam section.autolabel 0 \ | 83 | --stringparam section.autolabel 0 \ |
| 91 | --stringparam section.label.includes.component.label 0 \ | 84 | --stringparam section.label.includes.component.label 0 \ |
| 92 | --xinclude | 85 | --xinclude |
| 93 | ALLPREQ = html eclipse tarball | 86 | ALLPREQ = html tarball |
| 94 | TARFILES = brief-yoctoprojectqs-style.css brief-yoctoprojectqs.html figures/bypqs-title.png \ | 87 | TARFILES = brief-yoctoprojectqs-style.css brief-yoctoprojectqs.html figures/bypqs-title.png \ |
| 95 | figures/yocto-project-transp.png | 88 | figures/yocto-project-transp.png |
| 96 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | 89 | MANUALS = $(DOC)/$(DOC).html |
| 97 | FIGURES = figures | 90 | FIGURES = figures |
| 98 | STYLESHEET = $(DOC)/*.css | 91 | STYLESHEET = $(DOC)/*.css |
| 99 | 92 | ||
| @@ -101,7 +94,7 @@ endif | |||
| 101 | 94 | ||
| 102 | ifeq ($(DOC),overview-manual) | 95 | ifeq ($(DOC),overview-manual) |
| 103 | XSLTOPTS = --xinclude | 96 | XSLTOPTS = --xinclude |
| 104 | ALLPREQ = html eclipse tarball | 97 | ALLPREQ = html tarball |
| 105 | TARFILES = overview-manual-style.css overview-manual.html figures/overview-manual-title.png \ | 98 | TARFILES = 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 \ | 99 | 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 \ | 100 | figures/yp-download.png figures/YP-flow-diagram.png figures/key-dev-elements.png \ |
| @@ -110,9 +103,8 @@ TARFILES = overview-manual-style.css overview-manual.html figures/overview-manua | |||
| 110 | figures/package-feeds.png figures/patching.png figures/source-fetching.png \ | 103 | figures/package-feeds.png figures/patching.png figures/source-fetching.png \ |
| 111 | figures/configuration-compile-autoreconf.png figures/analysis-for-package-splitting.png \ | 104 | figures/configuration-compile-autoreconf.png figures/analysis-for-package-splitting.png \ |
| 112 | figures/image-generation.png figures/sdk-generation.png figures/images.png \ | 105 | figures/image-generation.png figures/sdk-generation.png figures/images.png \ |
| 113 | figures/sdk.png \ | 106 | figures/sdk.png |
| 114 | eclipse | 107 | MANUALS = $(DOC)/$(DOC).html |
| 115 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 116 | FIGURES = figures | 108 | FIGURES = figures |
| 117 | STYLESHEET = $(DOC)/*.css | 109 | STYLESHEET = $(DOC)/*.css |
| 118 | 110 | ||
| @@ -120,11 +112,10 @@ endif | |||
| 120 | 112 | ||
| 121 | ifeq ($(DOC),bsp-guide) | 113 | ifeq ($(DOC),bsp-guide) |
| 122 | XSLTOPTS = --xinclude | 114 | XSLTOPTS = --xinclude |
| 123 | ALLPREQ = html eclipse tarball | 115 | ALLPREQ = html tarball |
| 124 | TARFILES = bsp-style.css bsp-guide.html figures/bsp-title.png \ | 116 | TARFILES = bsp-style.css bsp-guide.html figures/bsp-title.png \ |
| 125 | figures/bsp-dev-flow.png \ | 117 | figures/bsp-dev-flow.png |
| 126 | eclipse | 118 | MANUALS = $(DOC)/$(DOC).html |
| 127 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 128 | FIGURES = figures | 119 | FIGURES = figures |
| 129 | STYLESHEET = $(DOC)/*.css | 120 | STYLESHEET = $(DOC)/*.css |
| 130 | 121 | ||
| @@ -132,7 +123,7 @@ endif | |||
| 132 | 123 | ||
| 133 | ifeq ($(DOC),dev-manual) | 124 | ifeq ($(DOC),dev-manual) |
| 134 | XSLTOPTS = --xinclude | 125 | XSLTOPTS = --xinclude |
| 135 | ALLPREQ = html eclipse tarball | 126 | ALLPREQ = html tarball |
| 136 | # | 127 | # |
| 137 | # Note that the tarfile might produce the "Cannot stat: No such file or | 128 | # 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 | 129 | # directory" error message for .PNG files that are not present when building |
| @@ -165,11 +156,10 @@ TARFILES = dev-style.css dev-manual.html \ | |||
| 165 | TARFILES = dev-style.css dev-manual.html figures/buildhistory-web.png \ | 156 | TARFILES = dev-style.css dev-manual.html figures/buildhistory-web.png \ |
| 166 | figures/dev-title.png figures/buildhistory.png \ | 157 | figures/dev-title.png figures/buildhistory.png \ |
| 167 | figures/recipe-workflow.png figures/bitbake-build-flow.png \ | 158 | figures/recipe-workflow.png figures/bitbake-build-flow.png \ |
| 168 | figures/multiconfig_files.png \ | 159 | figures/multiconfig_files.png |
| 169 | eclipse | ||
| 170 | endif | 160 | endif |
| 171 | 161 | ||
| 172 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | 162 | MANUALS = $(DOC)/$(DOC).html |
| 173 | FIGURES = figures | 163 | FIGURES = figures |
| 174 | STYLESHEET = $(DOC)/*.css | 164 | STYLESHEET = $(DOC)/*.css |
| 175 | 165 | ||
| @@ -230,7 +220,7 @@ TARFILES = mega-manual.html mega-style.css \ | |||
| 230 | figures/profile-title.png figures/kernelshark-all.png \ | 220 | figures/profile-title.png figures/kernelshark-all.png \ |
| 231 | figures/kernelshark-choose-events.png \ | 221 | figures/kernelshark-choose-events.png \ |
| 232 | figures/kernelshark-i915-display.png \ | 222 | figures/kernelshark-i915-display.png \ |
| 233 | figures/kernelshark-output-display.png figures/lttngmain0.png \ | 223 | figures/kernelshark-output-display.png \ |
| 234 | figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ | 224 | figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ |
| 235 | figures/oprofileui-downloading.png figures/oprofileui-processes.png \ | 225 | figures/oprofileui-downloading.png figures/oprofileui-processes.png \ |
| 236 | figures/perf-probe-do_fork-profile.png \ | 226 | figures/perf-probe-do_fork-profile.png \ |
| @@ -267,7 +257,7 @@ TARFILES = mega-manual.html mega-style.css \ | |||
| 267 | figures/compatible-layers.png figures/import-layer.png figures/new-project.png \ | 257 | figures/compatible-layers.png figures/import-layer.png figures/new-project.png \ |
| 268 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ | 258 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ |
| 269 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ | 259 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ |
| 270 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ | 260 | figures/sdk-devtool-modify-flow.png \ |
| 271 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \ | 261 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \ |
| 272 | figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \ | 262 | figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \ |
| 273 | figures/bb_multiconfig_files.png figures/bitbake-title.png | 263 | figures/bb_multiconfig_files.png figures/bitbake-title.png |
| @@ -281,37 +271,35 @@ endif | |||
| 281 | 271 | ||
| 282 | ifeq ($(DOC),ref-manual) | 272 | ifeq ($(DOC),ref-manual) |
| 283 | XSLTOPTS = --xinclude | 273 | XSLTOPTS = --xinclude |
| 284 | ALLPREQ = html eclipse tarball | 274 | ALLPREQ = html tarball |
| 285 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ | 275 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ |
| 286 | figures/build-workspace-directory.png \ | 276 | figures/build-workspace-directory.png |
| 287 | eclipse | 277 | MANUALS = $(DOC)/$(DOC).html |
| 288 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 289 | FIGURES = figures | 278 | FIGURES = figures |
| 290 | STYLESHEET = $(DOC)/*.css | 279 | STYLESHEET = $(DOC)/*.css |
| 291 | endif | 280 | endif |
| 292 | 281 | ||
| 293 | ifeq ($(DOC),sdk-manual) | 282 | ifeq ($(DOC),sdk-manual) |
| 294 | XSLTOPTS = --xinclude | 283 | XSLTOPTS = --xinclude |
| 295 | ALLPREQ = html eclipse tarball | 284 | ALLPREQ = html tarball |
| 296 | TARFILES = sdk-manual.html sdk-style.css figures/sdk-title.png \ | 285 | TARFILES = sdk-manual.html sdk-style.css figures/sdk-title.png \ |
| 297 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ | 286 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ |
| 298 | figures/sdk-installed-extensible-sdk-directory.png figures/sdk-devtool-add-flow.png \ | 287 | figures/sdk-installed-extensible-sdk-directory.png figures/sdk-devtool-add-flow.png \ |
| 299 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ | 288 | figures/sdk-devtool-modify-flow.png \ |
| 300 | figures/sdk-devtool-upgrade-flow.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \ | 289 | figures/sdk-devtool-upgrade-flow.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png |
| 301 | eclipse | 290 | MANUALS = $(DOC)/$(DOC).html |
| 302 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 303 | FIGURES = figures | 291 | FIGURES = figures |
| 304 | STYLESHEET = $(DOC)/*.css | 292 | STYLESHEET = $(DOC)/*.css |
| 305 | endif | 293 | endif |
| 306 | 294 | ||
| 307 | ifeq ($(DOC),profile-manual) | 295 | ifeq ($(DOC),profile-manual) |
| 308 | XSLTOPTS = --xinclude | 296 | XSLTOPTS = --xinclude |
| 309 | ALLPREQ = html eclipse tarball | 297 | ALLPREQ = html tarball |
| 310 | TARFILES = profile-manual.html profile-manual-style.css \ | 298 | TARFILES = profile-manual.html profile-manual-style.css \ |
| 311 | figures/profile-title.png figures/kernelshark-all.png \ | 299 | figures/profile-title.png figures/kernelshark-all.png \ |
| 312 | figures/kernelshark-choose-events.png \ | 300 | figures/kernelshark-choose-events.png \ |
| 313 | figures/kernelshark-i915-display.png \ | 301 | figures/kernelshark-i915-display.png \ |
| 314 | figures/kernelshark-output-display.png figures/lttngmain0.png \ | 302 | figures/kernelshark-output-display.png \ |
| 315 | figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ | 303 | figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \ |
| 316 | figures/oprofileui-downloading.png figures/oprofileui-processes.png \ | 304 | figures/oprofileui-downloading.png figures/oprofileui-processes.png \ |
| 317 | figures/perf-probe-do_fork-profile.png \ | 305 | figures/perf-probe-do_fork-profile.png \ |
| @@ -332,21 +320,19 @@ TARFILES = profile-manual.html profile-manual-style.css \ | |||
| 332 | figures/pychart-linux-yocto-rpm.png \ | 320 | figures/pychart-linux-yocto-rpm.png \ |
| 333 | figures/pychart-linux-yocto-rpm-nostrip.png \ | 321 | figures/pychart-linux-yocto-rpm-nostrip.png \ |
| 334 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ | 322 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ |
| 335 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \ | 323 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png |
| 336 | eclipse | 324 | MANUALS = $(DOC)/$(DOC).html |
| 337 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 338 | FIGURES = figures | 325 | FIGURES = figures |
| 339 | STYLESHEET = $(DOC)/*.css | 326 | STYLESHEET = $(DOC)/*.css |
| 340 | endif | 327 | endif |
| 341 | 328 | ||
| 342 | ifeq ($(DOC),kernel-dev) | 329 | ifeq ($(DOC),kernel-dev) |
| 343 | XSLTOPTS = --xinclude | 330 | XSLTOPTS = --xinclude |
| 344 | ALLPREQ = html eclipse tarball | 331 | ALLPREQ = html tarball |
| 345 | TARFILES = kernel-dev.html kernel-dev-style.css \ | 332 | TARFILES = kernel-dev.html kernel-dev-style.css \ |
| 346 | figures/kernel-dev-title.png figures/kernel-overview-2-generic.png \ | 333 | figures/kernel-dev-title.png figures/kernel-overview-2-generic.png \ |
| 347 | figures/kernel-architecture-overview.png figures/kernel-dev-flow.png \ | 334 | figures/kernel-architecture-overview.png figures/kernel-dev-flow.png |
| 348 | eclipse | 335 | MANUALS = $(DOC)/$(DOC).html |
| 349 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 350 | FIGURES = figures | 336 | FIGURES = figures |
| 351 | STYLESHEET = $(DOC)/*.css | 337 | STYLESHEET = $(DOC)/*.css |
| 352 | endif | 338 | endif |
| @@ -412,50 +398,6 @@ else | |||
| 412 | endif | 398 | endif |
| 413 | 399 | ||
| 414 | 400 | ||
| 415 | eclipse: BASE_DIR = html/$(DOC)/ | ||
| 416 | |||
| 417 | eclipse: eclipse-generate eclipse-resolve-links | ||
| 418 | |||
| 419 | .PHONY : eclipse-generate eclipse-resolve-links | ||
| 420 | |||
| 421 | eclipse-generate: | ||
| 422 | ifeq ($(filter $(DOC), overview-manual sdk-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual brief-yoctoprojectqs),) | ||
| 423 | @echo " " | ||
| 424 | @echo "ERROR: You can only create eclipse documentation" | ||
| 425 | @echo " of the following documentation parts:" | ||
| 426 | @echo " - overview-manual" | ||
| 427 | @echo " - sdk-manual" | ||
| 428 | @echo " - bsp-guide" | ||
| 429 | @echo " - dev-manual" | ||
| 430 | @echo " - kernel-dev" | ||
| 431 | @echo " - profile-manual" | ||
| 432 | @echo " - ref-manual" | ||
| 433 | @echo " - brief-yoctoprojectqs" | ||
| 434 | @echo " " | ||
| 435 | else | ||
| 436 | @echo " " | ||
| 437 | @echo "******** Building eclipse help of "$(DOC) | ||
| 438 | @echo " " | ||
| 439 | cd $(DOC) && \ | ||
| 440 | xsltproc $(XSLTOPTS) \ | ||
| 441 | --stringparam base.dir '$(BASE_DIR)' \ | ||
| 442 | -o eclipse/$(DOC).html \ | ||
| 443 | $(DOC)-eclipse-customization.xsl $(DOC).xml && \ | ||
| 444 | mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \ | ||
| 445 | cp -rf $(FIGURES) eclipse/$(BASE_DIR) && \ | ||
| 446 | cd ..; | ||
| 447 | |||
| 448 | $(call modify-eclipse) | ||
| 449 | endif | ||
| 450 | |||
| 451 | eclipse-resolve-links: | ||
| 452 | @echo " " | ||
| 453 | @echo "******** Using eclipse-help.sed to process external links" | ||
| 454 | @echo " " | ||
| 455 | $(foreach FILE, \ | ||
| 456 | $(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \ | ||
| 457 | $(shell sed -i -f tools/eclipse-help.sed $(FILE))) | ||
| 458 | |||
| 459 | tarball: html | 401 | tarball: html |
| 460 | @echo " " | 402 | @echo " " |
| 461 | @echo "******** Creating Tarball of document files" | 403 | @echo "******** Creating Tarball of document files" |
