sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity
generic-poky/documentation/Makefile

396 lines
17 KiB
Makefile
Raw Normal View History

- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
# This is a single Makefile to handle all generated Yocto Project documents.
# The Makefile needs to live in the documents directory and all figures used
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# in any manuals must be .PNG files and live in the individual book's figures
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# directory as well as in the figures directory for the mega-manual.
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# Note that the figures for the Yocto Project Development Manual
# differ depending on the BRANCH being built.
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
#
# The Makefile has these targets:
#
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# pdf: generates a PDF version of a manual. Not valid for the Quick Start
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# or the mega-manual (single, large HTML file comprised of all
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# Yocto Project manuals).
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# html: generates an HTML version of a manual.
documentation/Makefile: Clean up eclipse target and update help. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:52 +00:00
# eclipse: generates an HTML version of a manual that can be used as
# eclipse help (including necessary metadata files).
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# tarball: creates a tarball for the doc files.
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# validate: validates
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# publish: pushes generated files to the Yocto Project website
# clean: removes files
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
#
# The Makefile generates an HTML and PDF version of every document except the
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# of all the individual Yocto Project manuals. These two manuals are in HTML
# form only. The variable DOC indicates the folder name for a given manual. The
# variable VER represents the distro version of the Yocto Release for which the
# manuals are being generated. The variable BRANCH is used to indicate the
# branch (edison or denzil) and is used only when DOC=dev-manual or
# DOC=mega-manual. If you do not specify a BRANCH, the default branch used
# will be for the latest Yocto Project release. If you build for either
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>
2012-10-04 20:12:57 +00:00
# edison or denzil, you must use BRANCH. You do not need to use BRANCH for
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# any release beyond denzil.
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
#
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# To build a manual, you must invoke Makefile with the DOC argument. If you
# are going to publish the manual, then you must invoke Makefile with both the
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>
2012-10-04 20:12:57 +00:00
# DOC and the VER argument. Furthermore, if you are building or publishing
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# the edison or denzil versions of the Yocto Poject Development Manual or
# the mega-manual, you must also use the BRANCH argument.
documentation/Makefile: Updated comments for usage per Robert P. J. Day Robert Day correctly pointed out that the usage comments in the Makefile were not exactly accurate. The VER argument is necessary only if you are going to publish a document to the YP website. I updated the usage comments accordingly. (From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-29 12:46:52 +00:00
#
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
# Examples:
#
documentation/Makefile: Updated comments for usage per Robert P. J. Day Robert Day correctly pointed out that the usage comments in the Makefile were not exactly accurate. The VER argument is necessary only if you are going to publish a document to the YP website. I updated the usage comments accordingly. (From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-29 12:46:52 +00:00
# make DOC=bsp-guide
# make DOC=yocto-project-qs
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# make pdf DOC=ref-manual
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# make DOC=dev-manual BRANCH=edison
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# make DOC=mega-manual BRANCH=denzil
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
#
documentation/Makefile: Updated comments for usage per Robert P. J. Day Robert Day correctly pointed out that the usage comments in the Makefile were not exactly accurate. The VER argument is necessary only if you are going to publish a document to the YP website. I updated the usage comments accordingly. (From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-29 12:46:52 +00:00
# The first example generates the HTML and PDF versions of the BSP Guide.
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# The second example generates the HTML version only of the Quick Start. Note that
# the Quick Start only has an HTML version available. The third example generates
# both the PDF and HTML versions of the Yocto Project Reference Manual. The
# fourth example generates both the PDF and HTML 'edison' versions of the YP
# Development Manual. The last exmample generates the HTML version of the
# mega-manual and uses the 'denzil' branch when choosing figures for the
# tarball of figures. Any example that does not use the BRANCH argument
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>
2012-10-04 20:12:57 +00:00
# builds the current version of the manual set.
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
#
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# Use the publish target to push the generated manuals to the Yocto Project
# website. All files needed for the manual's HTML form are pushed as well as the
# PDF version (if applicable).
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
# Examples:
#
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# make publish DOC=bsp-guide VER=1.3
# make publish DOC=adt-manual VER=1.3
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
#
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# The first example publishes the 1.3 version of both the PDF and HTML versions of
# the BSP Guide. The second example publishes the 1.3 version of both the PDF and
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
# HTML versions of the ADT Manual. The third example publishes the PDF and HTML
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
# 'edison' versions of the YP Development Manual. The fourth example publishes
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>
2012-10-04 20:12:57 +00:00
# the PDF and HTML 'denzil' versions of the YP Development Manual.
documentation/Makefile: Updated comments for usage per Robert P. J. Day Robert Day correctly pointed out that the usage comments in the Makefile were not exactly accurate. The VER argument is necessary only if you are going to publish a document to the YP website. I updated the usage comments accordingly. (From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-29 12:46:52 +00:00
#
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
ifeq ($(DOC),bsp-guide)
documentation: Move bsp-guide global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:29 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for bsp guide and cleanup Eclipse help documents are now created when calling the 'make all' target on the bsp-guide. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:33 +00:00
ALLPREQ = html pdf eclipse tarball
TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
FIGURES = figures
documentation/Makefile: Added support for YP Dev Manual. (From yocto-docs rev: a10ec0aed26f75605b6113b5ed16934bc2b78621) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-15 13:19:17 +00:00
STYLESHEET = $(DOC)/*.css
endif
ifeq ($(DOC),dev-manual)
documentation: Move dev-manual global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:24 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for dev manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the dev-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:28 +00:00
ALLPREQ = html pdf eclipse tarball
documentation/Makefile: fixes for missing tarfiles I had added some edison-specific figures and they needed to be included in the TARFILE variable for the YP development manual. The fix now makes the TARFILE variable all-inclusive for all .PNG files regardless of branch. Consequently, there can be some missing files when the manual is made but the errors are okay. I documented the exceptions above the variable. (From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 03:27:11 +00:00
#
# Note that the tarfile might produce the "Cannot stat: No such file or directory" error
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# message for .PNG files that are not present when building a particular branch. The
documentation: release-specific figure needed for denzil in dev-manual dev-manual/dev-manual-model.xml: The Bare Clone and Copy of the Bare Clone figures are out of date for denzil. These needed to be re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work" as the root names. This presents a Makefile issue when making the denzil and pre-denzil versions of the manuals. Whenever you use a different figure for a different release, you need to involve the BRANCH variable in the Makefile. This is necessary because you are using different figures in the generated tarballs. The set of figures could be unique to the release. The outdated figure is "kernel-overview-3.png" and will eventually be removed (later commit). I created a new figure named "kernel-overview-3-denzil.png" and used that in the dev-manual-model.xml file. documentation/Makefile: I updated the Makefile to test for a "denzil" release build and if so include the new file in the generated tarball. This commit adds the new .PNG file as well. Fixed the Makefile so that if you don't supply a BRANCH value, it uses the latest figures (denzil). (From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-26 14:46:36 +00:00
# list of files is all-inclusive for all branches. Note, if you don't provide a BRANCH
# option, it defaults to the latest stuff. This would be appropriate for "master" branch.
documentation/Makefile: fixes for missing tarfiles I had added some edison-specific figures and they needed to be included in the TARFILE variable for the YP development manual. The fix now makes the TARFILE variable all-inclusive for all .PNG files regardless of branch. Consequently, there can be some missing files when the manual is made but the errors are okay. I documented the exceptions above the variable. (From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 03:27:11 +00:00
#
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
ifeq ($(BRANCH),edison)
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
documentation/Makefile: fixes for missing tarfiles I had added some edison-specific figures and they needed to be included in the TARFILE variable for the YP development manual. The fix now makes the TARFILE variable all-inclusive for all .PNG files regardless of branch. Consequently, there can be some missing files when the manual is made but the errors are okay. I documented the exceptions above the variable. (From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 03:27:11 +00:00
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
documentation/Makefile: Updated the dev-manual to include three new pics. (From yocto-docs rev: 6bd75cf91bb0a55d1c706d9249e12a24f24b30c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-31 13:55:59 +00:00
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
figures/kernel-example-repos-edison.png \
documentation/Makefile: fixes for missing tarfiles I had added some edison-specific figures and they needed to be included in the TARFILE variable for the YP development manual. The fix now makes the TARFILE variable all-inclusive for all .PNG files regardless of branch. Consequently, there can be some missing files when the manual is made but the errors are okay. I documented the exceptions above the variable. (From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 03:27:11 +00:00
figures/kernel-overview-1.png figures/kernel-overview-2.png \
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
figures/kernel-overview-3-edison.png \
documentation/Makefile: fixes for missing tarfiles I had added some edison-specific figures and they needed to be included in the TARFILE variable for the YP development manual. The fix now makes the TARFILE variable all-inclusive for all .PNG files regardless of branch. Consequently, there can be some missing files when the manual is made but the errors are okay. I documented the exceptions above the variable. (From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 03:27:11 +00:00
figures/source-repos.png figures/yp-download.png \
documenation/Makefile: Added a "WIP" figure dev manual for future work. (From yocto-docs rev: 90964c51b1cd848a7bb0ddce5dcfd0a0f8c86223) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:53:13 +00:00
figures/wip.png
documentation: release-specific figure needed for denzil in dev-manual dev-manual/dev-manual-model.xml: The Bare Clone and Copy of the Bare Clone figures are out of date for denzil. These needed to be re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work" as the root names. This presents a Makefile issue when making the denzil and pre-denzil versions of the manuals. Whenever you use a different figure for a different release, you need to involve the BRANCH variable in the Makefile. This is necessary because you are using different figures in the generated tarballs. The set of figures could be unique to the release. The outdated figure is "kernel-overview-3.png" and will eventually be removed (later commit). I created a new figure named "kernel-overview-3-denzil.png" and used that in the dev-manual-model.xml file. documentation/Makefile: I updated the Makefile to test for a "denzil" release build and if so include the new file in the generated tarball. This commit adds the new .PNG file as well. Fixed the Makefile so that if you don't supply a BRANCH value, it uses the latest figures (denzil). (From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-26 14:46:36 +00:00
else ifeq ($(BRANCH),denzil)
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
documentation/Makefile: Added denzil specific .PNG file logic A new figure was needed in the Kernel appendix. I added that figure to the block of code that creates the tarball for the denzil branch. (From yocto-docs rev: 352093f3eabf64052d78a41fd997993d09aa10ef) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-27 12:08:27 +00:00
figures/kernel-example-repos-denzil.png \
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
figures/kernel-overview-1.png figures/kernel-overview-2.png \
documentation: release-specific figure needed for denzil in dev-manual dev-manual/dev-manual-model.xml: The Bare Clone and Copy of the Bare Clone figures are out of date for denzil. These needed to be re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work" as the root names. This presents a Makefile issue when making the denzil and pre-denzil versions of the manuals. Whenever you use a different figure for a different release, you need to involve the BRANCH variable in the Makefile. This is necessary because you are using different figures in the generated tarballs. The set of figures could be unique to the release. The outdated figure is "kernel-overview-3.png" and will eventually be removed (later commit). I created a new figure named "kernel-overview-3-denzil.png" and used that in the dev-manual-model.xml file. documentation/Makefile: I updated the Makefile to test for a "denzil" release build and if so include the new file in the generated tarball. This commit adds the new .PNG file as well. Fixed the Makefile so that if you don't supply a BRANCH value, it uses the latest figures (denzil). (From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-26 14:46:36 +00:00
figures/kernel-overview-3-denzil.png \
figures/source-repos.png figures/yp-download.png \
figures/wip.png
else
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
documentation: release-specific figure needed for denzil in dev-manual dev-manual/dev-manual-model.xml: The Bare Clone and Copy of the Bare Clone figures are out of date for denzil. These needed to be re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work" as the root names. This presents a Makefile issue when making the denzil and pre-denzil versions of the manuals. Whenever you use a different figure for a different release, you need to involve the BRANCH variable in the Makefile. This is necessary because you are using different figures in the generated tarballs. The set of figures could be unique to the release. The outdated figure is "kernel-overview-3.png" and will eventually be removed (later commit). I created a new figure named "kernel-overview-3-denzil.png" and used that in the dev-manual-model.xml file. documentation/Makefile: I updated the Makefile to test for a "denzil" release build and if so include the new file in the generated tarball. This commit adds the new .PNG file as well. Fixed the Makefile so that if you don't supply a BRANCH value, it uses the latest figures (denzil). (From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-26 14:46:36 +00:00
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
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>
2012-10-04 20:12:57 +00:00
figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
dev-manual, mega-manual, Makefile: Added new recipe creation flow figure. (From yocto-docs rev: c031c014bae6d6e4a239a4bcd1e8b9d5d272f851) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Created a new figure for the flow. This involved putting the figure into the "Figures" directory of both the dev-manual and the mega-manual and then updating Makefile to include the figure in the TARBALL variable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-08 22:07:35 +00:00
figures/source-repos.png figures/yp-download.png figures/recipe-workflow.png \
documentation/Makefile: logic to make all for dev manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the dev-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:28 +00:00
eclipse
documentation/Makefile: new 'edison' variable for YP dev manual. I discovered that the figures used in this manual differ depending on the branch. There are two figures that are different. Thus, the TARFILES variable in the makefile needed to be conditionalized. If it is not, then the process that makes the tarball throws errors because it cannot find the two figures from the other branch. To fix this I introduced the 'BRANCH' variable. It is to be used only when you make or publish the YP Development Manual. And, you only use it to specify 'edison'. If you are building from the 'master' branch you don't need to use it. Comments in the file have been updated to explain usage. (From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-25 14:38:17 +00:00
endif
documentation/Makefile: logic to make all for dev manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the dev-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:28 +00:00
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
documentation/Makefile: Added support for YP Dev Manual. (From yocto-docs rev: a10ec0aed26f75605b6113b5ed16934bc2b78621) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-15 13:19:17 +00:00
FIGURES = figures
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
STYLESHEET = $(DOC)/*.css
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
endif
ifeq ($(DOC),yocto-project-qs)
documentation: Move yocto-project-qs global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:44 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for yocto-project-qs and cleanup Eclipse help documents are now created when calling the 'make all' target on the yocto-project-qs. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:49 +00:00
ALLPREQ = html eclipse tarball
TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \
figures/building-an-image.png figures/using-a-pre-built-image.png \
yocto-project-qs, mega-manual: Conformed to YP book set I discovered some artifacts and inconsistencies with how the YP Quick Start was made. I made the following changes: 1. Changed the structure of the QS from "article" to "book" as it is a separate book. This change doesn't fix anything but it does bring the XML file closer to passing validation. 2. Removed the <abstract></abstract> tag. This tag was in place simply to display the PNG file for the Yocto logo in the upper right part of the first page. After turning the QS into a book from an article, the title could be displayed as a PNG file similar to the other books. This change solved two issues: 1) removed the empty "abstract" element from being displayed in both the mega-manual and the PDF version, and 2), brought the author and look of the first page into line with other YP manuals. 3. Removed the old PNG file used to display the Yocto logo at the top of the QS. This file was removed from both the yocto-project-qs and mega-manual "figures" directories. 4. Added a new "yocto-project-qs-title.png" file to both the yocto-project-qs and mega-manual "figures" directories. 5. Updated the "qs-style.css" file's .authorgroup element to match and behave like the other YP manuals. This effectively correctly displays the title PNG file for the QS. 6. Updated the Makefile area where the TAR files are made for both the yocto-project-qs and the mega-manual. I had to substitute in the new PNG file for the QS one and had to add the title PNG to the mega-manual part. (From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-15 15:31:59 +00:00
figures/yocto-project-qs-title.png \
documentation/Makefile: logic to make all for yocto-project-qs and cleanup Eclipse help documents are now created when calling the 'make all' target on the yocto-project-qs. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:49 +00:00
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
FIGURES = figures
STYLESHEET = $(DOC)/*.css
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
endif
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
ifeq ($(DOC),mega-manual)
XSLTOPTS = --stringparam html.stylesheet mega-style.css \
--stringparam chapter.autolabel 1 \
--stringparam section.autolabel 1 \
--stringparam section.label.includes.component.label 1 \
--xinclude
ALLPREQ = html tarball
ifeq ($(BRANCH),edison)
TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
figures/using-a-pre-built-image.png \
figures/poky-title.png \
figures/adt-title.png figures/bsp-title.png \
figures/kernel-title.png figures/kernel-architecture-overview.png \
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
figures/kernel-example-repos-edison.png \
figures/kernel-overview-1.png figures/kernel-overview-2.png \
figures/kernel-overview-3-edison.png \
figures/source-repos.png figures/yp-download.png \
figures/wip.png
else ifeq ($(BRANCH),denzil)
TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
figures/using-a-pre-built-image.png \
figures/poky-title.png \
figures/adt-title.png figures/bsp-title.png \
figures/kernel-title.png figures/kernel-architecture-overview.png \
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
figures/kernel-example-repos-denzil.png \
figures/kernel-overview-1.png figures/kernel-overview-2.png \
figures/kernel-overview-3-denzil.png \
figures/source-repos.png figures/yp-download.png \
figures/wip.png
else
TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
figures/using-a-pre-built-image.png \
documentation: poky-ref-manual, mega-manual, Makefile - new variables Added variable descriptions for BB_DISKMON_DIRS and BB_DISKMON_WARNINTERVAL. These went in the reference manual in the glossary section. First draft for both descriptions. Also, updated the Makefile to include two new figures used in the Build History section. The figures needed to be added to the TARFILE variable so that the .PNG files are included when publishing both the poky-ref-manual and the mega-manual. Added two figures to the figures directories of the poky-ref-manual and the mega-manual. These figures are part of the new Build History section. Anytime you add a figure to any manual you also have to store it in the figures directory of the mega-manual. (From yocto-docs rev: bbf68ed28ba8660af34d4cae146fb172ca4e681e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-02 20:45:49 +00:00
figures/poky-title.png figures/buildhistory.png figures/buildhistory-web.png \
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
figures/adt-title.png figures/bsp-title.png \
Makefile: Removed bits that support kernel-manual I took out the logic that built the old YP Kernel Architecture and Use Manual. This manual can no longer be build. It is being retired. (From yocto-docs rev: 8d5b179995e561deb94572150e904da5cd4dec19) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-28 21:07:53 +00:00
figures/kernel-dev-title.png figures/kernel-architecture-overview.png \
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
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>
2012-10-04 20:12:57 +00:00
figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
Makefile: Removed bits that support kernel-manual I took out the logic that built the old YP Kernel Architecture and Use Manual. This manual can no longer be build. It is being retired. (From yocto-docs rev: 8d5b179995e561deb94572150e904da5cd4dec19) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-28 21:07:53 +00:00
figures/source-repos.png figures/yp-download.png \
Makefile: Updated to support mega-manual build with profile-manual Added the list of 32 profile-manual figures to the tarfile variable for mega-manual. (From yocto-docs rev: ffe0586990c7659c28001038d6ba55cd42f5ecd0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-21 19:22:26 +00:00
figures/profile-title.png figures/kernelshark-all.png \
figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \
figures/kernelshark-output-display.png figures/lttngmain0.png \
figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
figures/oprofileui-downloading.png figures/oprofileui-processes.png \
figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \
figures/perf-systemwide.png figures/perf-systemwide-libc.png \
figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \
figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \
figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \
figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \
figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \
figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \
figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \
figures/sched-wakeup-profile.png figures/sysprof-callers.png \
Makefile: Added new figures to the TARBALL variables. Needed to add six new figures to the mega-manual TARBALL and five figures to the ref-manual TARBALL. (From yocto-docs rev: 296e356cbd6a65d187a3e3d7905566685580f575) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-07-30 19:49:06 +00:00
figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \
Makefile: Corrected figure file name. I left off the ".png" part of a figure in the TARBALL statement. (From yocto-docs rev: e1024da36a94dd3cb8c0679782bedaba4bf2e5dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-07-31 06:53:45 +00:00
figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \
ref-manual, Makefile: New section on BitBake for expanded build Fixes [YOCTO #2808] Created a new section called "BitBake" that will provide an expanded discussion of the basic YP build process. The "BitBake" section has a new sub-section called "Source Fetching." Part of the new section is a new figure named source-fetching.png. The figure must reside in the "figures" directory in both the ref-manual and the mega-manual. It must also be listed for each of these manuals in the TARBALL statement in the Makefile. (From yocto-docs rev: 41eff3e755a98ff31cadccfb1cd7dfcf569b4d9e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-14 19:29:50 +00:00
figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \
Makefile: Added new figure for package creation. Fixes [YOCTO #2808] The new section on package creation required a new figure. I added the figure to the TARBALL creation part for both the ref-manual and the mega-manual. (From yocto-docs rev: 3e752dd95659282833519bff866adc940a156ba7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-21 15:57:08 +00:00
figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \
ref-manual, mega-manual, Makefile: New figure added for sdk Fixes [YOCTO #2808] Added a new figure to support the expanded section on SDK generation. Figure added to "figures" directory for both the ref-manual and the mega-manual. Updated Makefile to include the figure in the TARBALL variable for both the manuals. (From yocto-docs rev: 41f78fddfd871fdd4c1c963b98093567d4b4d230) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-16 22:38:23 +00:00
figures/analysis-for-package-splitting.png figures/image-generation.png \
yocto-project-qs, mega-manual: Conformed to YP book set I discovered some artifacts and inconsistencies with how the YP Quick Start was made. I made the following changes: 1. Changed the structure of the QS from "article" to "book" as it is a separate book. This change doesn't fix anything but it does bring the XML file closer to passing validation. 2. Removed the <abstract></abstract> tag. This tag was in place simply to display the PNG file for the Yocto logo in the upper right part of the first page. After turning the QS into a book from an article, the title could be displayed as a PNG file similar to the other books. This change solved two issues: 1) removed the empty "abstract" element from being displayed in both the mega-manual and the PDF version, and 2), brought the author and look of the first page into line with other YP manuals. 3. Removed the old PNG file used to display the Yocto logo at the top of the QS. This file was removed from both the yocto-project-qs and mega-manual "figures" directories. 4. Added a new "yocto-project-qs-title.png" file to both the yocto-project-qs and mega-manual "figures" directories. 5. Updated the "qs-style.css" file's .authorgroup element to match and behave like the other YP manuals. This effectively correctly displays the title PNG file for the QS. 6. Updated the Makefile area where the TAR files are made for both the yocto-project-qs and the mega-manual. I had to substitute in the new PNG file for the QS one and had to add the title PNG to the mega-manual part. (From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-15 15:31:59 +00:00
figures/sdk-generation.png figures/recipe-workflow.png figures/yocto-project-qs-title.png
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
endif
MANUALS = $(DOC)/$(DOC).html
FIGURES = figures
STYLESHEET = $(DOC)/*.css
endif
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
ifeq ($(DOC),ref-manual)
documentation: Move poky-ref-manual global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:39 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for poky-ref-manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the poky-ref-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:43 +00:00
ALLPREQ = html pdf eclipse tarball
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
Makefile: Added figure cross-development-toolchains.png A new figure was introduced in the ref-manual. This required the figure to be added to the list for tarball creation for both the ref-manual and the mega-manual. (From yocto-docs rev: 4179b6284f9d5fb87dec5d0442f7637b1e15de30) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 14:30:04 +00:00
figures/buildhistory.png figures/buildhistory-web.png eclipse \
Makefile: Added new figures to the TARBALL variables. Needed to add six new figures to the mega-manual TARBALL and five figures to the ref-manual TARBALL. (From yocto-docs rev: 296e356cbd6a65d187a3e3d7905566685580f575) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-07-30 19:49:06 +00:00
figures/cross-development-toolchains.png figures/layer-input.png \
figures/package-feeds.png figures/source-input.png \
ref-manual, mega-manual: New section for images/SDK Fixes [YOCTO #2808] Added a new section for the closer look at how BitBake creates images and the SDK installer files. This included the section itself, a new .PNG figure that had to be added to the figures directory of both the ref-manual and the mega-manual. Finally, the Makefile needed to be edited so that the tarballs for the ref-manual and mega-manual also included the new figure. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-02 13:56:40 +00:00
figures/user-configuration.png figures/yocto-environment-ref.png \
Makefile: Updated with new figure. Fixes [YOCTO #2808] Had to add the patching.png figure to the TARBALL for the mega-manual and the ref-manual. (From yocto-docs rev: fe51c2c76f364956683c484527e245a745920dc1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-19 14:20:23 +00:00
figures/images.png figures/sdk.png figures/source-fetching.png \
Makefile: Added new figure for package creation. Fixes [YOCTO #2808] The new section on package creation required a new figure. I added the figure to the TARBALL creation part for both the ref-manual and the mega-manual. (From yocto-docs rev: 3e752dd95659282833519bff866adc940a156ba7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-21 15:57:08 +00:00
figures/patching.png figures/configuration-compile-autoreconf.png \
ref-manual, mega-manual, Makefile: New figure added for sdk Fixes [YOCTO #2808] Added a new figure to support the expanded section on SDK generation. Figure added to "figures" directory for both the ref-manual and the mega-manual. Updated Makefile to include the figure in the TARBALL variable for both the manuals. (From yocto-docs rev: 41f78fddfd871fdd4c1c963b98093567d4b4d230) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-16 22:38:23 +00:00
figures/analysis-for-package-splitting.png figures/image-generation.png \
figures/sdk-generation.png
documentation/Makefile: logic to make all for poky-ref-manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the poky-ref-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:43 +00:00
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
FIGURES = figures
STYLESHEET = $(DOC)/*.css
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
endif
ifeq ($(DOC),adt-manual)
documentation: Move adt-manual global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Furthermore supporting new output formats can now be achieved by creating a new customization file containing its corresponding parameters. Parameters that are used across different stylesheets with different values will then be separated through different customization files. Global parameters can still be set through the XSLTOPTS variable since this precedes the parameters in the customization file. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:19 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for adt manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the adt-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:23 +00:00
ALLPREQ = html pdf eclipse tarball
TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
FIGURES = figures
STYLESHEET = $(DOC)/*.css
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
endif
Makefile: Added support for the new profile-manual. (From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 20:37:54 +00:00
ifeq ($(DOC),profile-manual)
documentation: Part 1 of 2 updates to integrating docs to Eclipse help. Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-08 15:16:33 +00:00
XSLTOPTS = --xinclude
ALLPREQ = html pdf eclipse tarball
Makefile: Added support for the new profile-manual. (From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 20:37:54 +00:00
TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \
figures/profile-title.png figures/kernelshark-all.png \
figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \
figures/kernelshark-output-display.png figures/lttngmain0.png \
figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
figures/oprofileui-downloading.png figures/oprofileui-processes.png \
figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \
figures/perf-systemwide.png figures/perf-systemwide-libc.png \
figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \
figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \
figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \
figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \
figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \
figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \
figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \
figures/sched-wakeup-profile.png figures/sysprof-callers.png \
yocto-docs: Fixup a couple of merge issues Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:30:09 +00:00
figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
Makefile: Added support for the new profile-manual. (From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 20:37:54 +00:00
FIGURES = figures
STYLESHEET = $(DOC)/*.css
endif
kernel-dev: Updates to get the new kernel-dev manual to make These changes were to the intro chapter to introduce the DocBook form, the Makefile to introduce the new manual, the figure used for the title had to be updated, the root manual .XML file needed changed, and the style sheet. The manual now makes with just the raw text for Darren's intro section. (From yocto-docs rev: 1bceb7bdd4fe5773c11c7ddbdae00554680bbf6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-17 23:56:26 +00:00
ifeq ($(DOC),kernel-dev)
documentation: Move kernel-manual global parameters to customization file Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:34 +00:00
XSLTOPTS = --xinclude
documentation/Makefile: logic to make all for kernel-manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the kernel-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:38 +00:00
ALLPREQ = html pdf eclipse tarball
kernel-dev: Added "Kernel Architecture" section. Moved the "Kernel Architecture" section from the YP Kernel Architecture and Use Manual to this manual. The section included the kernel-architecture-overview.png figure. So, I added that PNG file to the "figures" folder. Finally, I had to also add the PNG file to the Makefile tarfile list for kernel-dev. Note that because the figure was part of the old YP Kernel Architecture and Use Manual, I did not have to add the figure to the mega-manual tarfile list. (From yocto-docs rev: fbc5508ce162ea7915fd5dce74338b6a5bfd7ce1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-28 17:29:51 +00:00
TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png \
documentation/Makefile: logic to make all for kernel-manual and cleanup Eclipse help documents are now created when calling the 'make all' target on the kernel-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:38 +00:00
figures/kernel-architecture-overview.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
kernel-dev: Updates to get the new kernel-dev manual to make These changes were to the intro chapter to introduce the DocBook form, the Makefile to introduce the new manual, the figure used for the title had to be updated, the root manual .XML file needed changed, and the style sheet. The manual now makes with just the raw text for Darren's intro section. (From yocto-docs rev: 1bceb7bdd4fe5773c11c7ddbdae00554680bbf6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-17 23:56:26 +00:00
FIGURES = figures
STYLESHEET = $(DOC)/*.css
endif
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
##
# These URI should be rewritten by your distribution's xml catalog to
# match your localy installed XSL stylesheets.
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
all: $(ALLPREQ)
pdf:
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
ifeq ($(DOC),yocto-project-qs)
@echo " "
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@echo "ERROR: You cannot generate a yocto-project-qs PDF file."
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
@echo " "
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
else ifeq ($(DOC),mega-manual)
@echo " "
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@echo "ERROR: You cannot generate a mega-manual PDF file."
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
@echo " "
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
else
documentation/Makefile: Changes for new style sheets and mega-manual I added new style.css names for the individual manuals. Also, created a new entry for the mega-manual. This will generate an HTML file only (similar to the QS). No PDF file will be generated. The entry creates an appropriate mega-manual.tgz file as well and can be branch-dependent (like the dev manual) since it will obviously include the dev manual. (From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-17 00:16:01 +00:00
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
- documentation/Makefile: Cleaned up Makefile [BUGID#_1025] - I added some conditionals to handle the Yocto Project Quick Start case. This manual does not have a PDF version. I put in tests for publishing and for a case where a user might attempt to specifically generate a PDF using 'make pdf'. I also converted the version variable into a command-line argument so we don't have to edit the make file when a new release comes out. (From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-03 15:44:36 +00:00
endif
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
html:
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
ifeq ($(DOC),mega-manual)
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@echo " "
@echo "******** Building "$(DOC)
@echo " "
cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
@echo " "
@echo "******** Using mega-manual.sed to process external links"
@echo " "
cd $(DOC); sed -f ../tools/mega-manual.sed < mega-manual.html > mega-output.html; cd ..
@echo " "
@echo "******** Cleaning up transient file mega-output.html"
@echo " "
cd $(DOC); rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..
else
Documentation: Makefile - Changes to support ref-manual folder Updates to allow the reference manual to be built as ref-manual.htm and ref-manual.pdf. (From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 18:10:53 +00:00
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@echo " "
@echo "******** Building "$(DOC)
@echo " "
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
endif
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
documentation/Makefile: Support for making Eclipse HTML adt manual This target will generate eclipse help for the adt-manual using the adt-manual-eclipse-customization.xsl stylesheet. The output will be generated to a separate directory which can be used for integrating the documentation into eclipse. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:21 +00:00
eclipse: BASE_DIR = html/$(DOC)/
documentation/Makefile: Added conversion of links to other documentation parts. The script tools/eclipse-help.sed is used to convert links that point to other documentation parts. This avoids having to leave the eclipse help center when clicking these links. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:51 +00:00
eclipse: eclipse-generate eclipse-resolve-links
.PHONY : eclipse-generate eclipse-resolve-links
eclipse-generate:
documentation: Part 1 of 2 updates to integrating docs to Eclipse help. Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-08 15:16:33 +00:00
ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual yocto-project-qs),)
documentation/Makefile: Support for making Eclipse HTML dev manual This target will generate eclipse help for the dev-manual using the dev-manual-eclipse-customization.xsl stylesheet. The output will be generated to a separate directory which can be used for integrating the documentation into eclipse. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:26 +00:00
@echo " "
documentation: Part 1 of 2 updates to integrating docs to Eclipse help. Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-08 15:16:33 +00:00
@echo "ERROR: You can only create eclipse documentation"
@echo " of the following documentation parts:"
@echo " - adt-manual"
@echo " - bsp-guide"
@echo " - dev-manual"
@echo " - kernel-dev"
@echo " - profile-manual"
@echo " - ref-manual"
@echo " - yocto-project-qs"
documentation/Makefile: Support for making Eclipse HTML adt manual This target will generate eclipse help for the adt-manual using the adt-manual-eclipse-customization.xsl stylesheet. The output will be generated to a separate directory which can be used for integrating the documentation into eclipse. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:21 +00:00
@echo " "
else
@echo " "
@echo "******** Building eclipse help of "$(DOC)
@echo " "
cd $(DOC) && \
xsltproc $(XSLTOPTS) \
--stringparam base.dir '$(BASE_DIR)' \
-o eclipse/$(DOC).html \
$(DOC)-eclipse-customization.xsl $(DOC).xml && \
mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
documentation/Makefile: Fix copying of figures folder When calling the eclipse target twice without calling clean in between the figures folder was copied as a subfolder of the existing figures folder. This patch fixes the copy command to correctly copy the figures folder. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-06 09:19:51 +00:00
cp -rf $(FIGURES) eclipse/$(BASE_DIR) && \
documentation/Makefile: Added conversion of links to other documentation parts. The script tools/eclipse-help.sed is used to convert links that point to other documentation parts. This avoids having to leave the eclipse help center when clicking these links. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:51 +00:00
cd ..;
$(call modify-eclipse)
documentation/Makefile: Support for making Eclipse HTML adt manual This target will generate eclipse help for the adt-manual using the adt-manual-eclipse-customization.xsl stylesheet. The output will be generated to a separate directory which can be used for integrating the documentation into eclipse. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:21 +00:00
endif
documentation/Makefile: Added conversion of links to other documentation parts. The script tools/eclipse-help.sed is used to convert links that point to other documentation parts. This avoids having to leave the eclipse help center when clicking these links. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-11-30 08:59:51 +00:00
eclipse-resolve-links:
@echo " "
@echo "******** Using eclipse-help.sed to process external links"
@echo " "
$(foreach FILE, \
$(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \
$(shell sed -i -f tools/eclipse-help.sed $(FILE)))
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
tarball: html
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@echo " "
@echo "******** Creating Tarball of document files"
@echo " "
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
validate:
cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
publish:
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
@if test -f $(DOC)/$(DOC).html; \
then \
echo " "; \
echo "******** Publishing "$(DOC)".html"; \
echo " "; \
Makefile: Updated ssh push string. (From yocto-docs rev: 0871329d11ddb3626ede0aa334180e75badabc39) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-13 21:47:46 +00:00
scp -r $(MANUALS) $(STYLESHEET) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
cd $(DOC); scp -r $(FIGURES) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
documentation/Makefile: Added mega-file, comments, and publish test Three things done to the Makefile: 1. Added logic so that the user can generate the mega-manual HTML document. It includes processing links using mega-manual.sed 2. Added and updated the comments for 1.3 and inclusive of mega-manual generation. 3. Added a test for the existance of HTML file in the publish task. Previously you got some error that was geeky. (From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-23 00:30:54 +00:00
else \
echo " "; \
echo $(DOC)".html missing. Generate the file first then try again."; \
echo " "; \
fi
documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-02 17:18:35 +00:00
clean:
documentation: Makefile - Added tarfile to the clean target Clean operation should also remove the *.tgz file. I added code so that if the user makes the file and specifies the 'clean' target, the generated tarfile is removed. (From yocto-docs rev: 565c147eaa169e287278b87e9bba2979a44be9d5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-06 11:44:23 +00:00
rm -rf $(MANUALS); rm $(DOC)/$(DOC).tgz;