diff options
Diffstat (limited to 'documentation/Makefile')
| -rw-r--r-- | documentation/Makefile | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 176f38ee0e..0acb53db7c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -17,17 +17,20 @@ | |||
| 17 | # The command-line argument DOC represents the folder name in which a particular | 17 | # The command-line argument DOC represents the folder name in which a particular |
| 18 | # document is stored. The command-line argument VER represents the distro | 18 | # document is stored. The command-line argument VER represents the distro |
| 19 | # version of the Yocto Release for which the manuals are being generated. | 19 | # version of the Yocto Release for which the manuals are being generated. |
| 20 | # You must invoke the Makefile with the DOC and VER arguments. | 20 | # 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 | ||
| 22 | # you must invoke the Makefile with both the DOC and the VER argument. | ||
| 23 | # | ||
| 21 | # Examples: | 24 | # Examples: |
| 22 | # | 25 | # |
| 23 | # make DOC=bsp-guide VER=1.1 | 26 | # make DOC=bsp-guide |
| 24 | # make DOC=yocto-project-qs VER=1.1 | 27 | # make DOC=yocto-project-qs |
| 25 | # make pdf DOC=yocto-project-qs VER=1.1 | 28 | # make pdf DOC=poky-ref-manual |
| 26 | # | 29 | # |
| 27 | # The first example generates the HTML and PDF versions of the BSP Guide for | 30 | # The first example generates the HTML and PDF versions of the BSP Guide. |
| 28 | # the Yocto Project 1.1 Release. The second example generates the HTML version | 31 | # The second example generates the HTML version only of the Quick Start. Note that |
| 29 | # of the Quick Start. The third example generates an error because you cannot | 32 | # the Quick Start only has an HTML version available. The third example generates |
| 30 | # generate a PDF version of the Quick Start. | 33 | # both the PDF and HTML versions of the Yocto Project Reference Manual. |
| 31 | # | 34 | # |
| 32 | # Use the publish target to push the generated manuals to the Yocto Project | 35 | # Use the publish target to push the generated manuals to the Yocto Project |
| 33 | # website. All files needed for the manual's HTML form are pushed as well as the | 36 | # website. All files needed for the manual's HTML form are pushed as well as the |
| @@ -37,6 +40,10 @@ | |||
| 37 | # make publish DOC=bsp-guide VER=1.1 | 40 | # make publish DOC=bsp-guide VER=1.1 |
| 38 | # make publish DOC=adt-manual VER=1.1 | 41 | # make publish DOC=adt-manual VER=1.1 |
| 39 | # | 42 | # |
| 43 | # The first example publishes the 1.1 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 | ||
| 45 | # HTML versions of the ADT Manual. | ||
| 46 | # | ||
| 40 | 47 | ||
| 41 | ifeq ($(DOC),bsp-guide) | 48 | ifeq ($(DOC),bsp-guide) |
| 42 | XSLTOPTS = --stringparam html.stylesheet style.css \ | 49 | XSLTOPTS = --stringparam html.stylesheet style.css \ |