summaryrefslogtreecommitdiffstats
path: root/documentation/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* documentation/Makefile: Added mega-file, comments, and publish testScott Rifenbark2012-09-041-23/+67
| | | | | | | | | | | | | | | | | | 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>
* documentation/Makefile: Changes for new style sheets and mega-manualScott Rifenbark2012-09-041-14/+76
| | | | | | | | | | | | | | | 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>
* documentation/Makefile: Fixed figures publishing bugScott Rifenbark2012-05-011-1/+1
| | | | | | | | | | | | | | | | | | I discovered a bug when publishing documents. There are two scp commands that copy a document's files and figures to the appropriate directory in the srifenbark@yocto-www:~/www.yoctoproject.or-docs server where the manuals are published. The second scp command had a "/figures" at the end. This was causing a new "figures" directory to be created within the "figures" directory. This redundancy shows up as missing figures in the manuals if a new figure or changed figure is ever added to the book after initial publishing. I removed the extra "/figures" at the end of the scp command. (From yocto-docs rev: cef3634e695f61bfb8465f1fb7a88e4e8a9a00f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Added denzil specific .PNG file logicScott Rifenbark2012-05-011-2/+2
| | | | | | | | | | | 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>
* documentation: release-specific figure needed for denzil in dev-manualScott Rifenbark2012-05-011-3/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* documentation/Makefile: new 'edison' variable for YP dev manual.Scott Rifenbark2012-03-081-18/+44
| | | | | | | | | | | | | | | | | | | | 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>
* documentation/Makefile: fixes for missing tarfilesScott Rifenbark2012-03-081-3/+11
| | | | | | | | | | | | | | 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>
* documenation/Makefile: Added a "WIP" figure dev manual for future work.Scott Rifenbark2011-10-041-1/+2
| | | | | | | (From yocto-docs rev: 90964c51b1cd848a7bb0ddce5dcfd0a0f8c86223) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Updated the dev-manual to include three new pics.Scott Rifenbark2011-09-021-3/+4
| | | | | | | (From yocto-docs rev: 6bd75cf91bb0a55d1c706d9249e12a24f24b30c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Updated comments for usage per Robert P. J. DayScott Rifenbark2011-08-301-8/+15
| | | | | | | | | | | | 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>
* documentation/Makefile: Removed sato image from tarfile list in poky-ref-manual.Scott Rifenbark2011-08-231-1/+1
| | | | | | | (From yocto-docs rev: 350ba4e6c799ec0c98bd50f097815306e0911f37) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: added git-workflow.png and kernel-dev-flow-png to ↵Scott Rifenbark2011-08-201-1/+1
| | | | | | | | | tarball list. (From yocto-docs rev: e518ae5ede03d51cddde7170685e1801d1af8a33) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Updated tarfile listScott Rifenbark2011-08-151-1/+2
| | | | | | | | | I added the figures/kernel-example-repos.png to the list of tarfiles. (From yocto-docs rev: 8967a9b8ae6fb27f7c0aeb44c2d04eacba98ed81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Added figures to tarfile list.Scott Rifenbark2011-08-041-1/+2
| | | | | | | (From yocto-docs rev: 45afc45abbfc5bc8910c263bd876cb40bdeb732b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Added the figure bsp-dev-flow.png to tarlist.Scott Rifenbark2011-08-041-1/+1
| | | | | | | (From yocto-docs rev: 50f2a36a298e77b1c36037d46c9ad5a79ec23c44) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Added support for YP Dev Manual.Scott Rifenbark2011-07-211-0/+14
| | | | | | | (From yocto-docs rev: a10ec0aed26f75605b6113b5ed16934bc2b78621) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* - documentation/Makefile: Cleaned up MakefileScott Rifenbark2011-06-131-6/+64
| | | | | | | | | | | | | | | [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>
* documentation/bsp-guide/Makefile: Fixed publishScott Rifenbark2011-06-131-2/+2
| | | | | | | | | | There was some URL problems with the publish statement. Beth debugged it. (From yocto-docs rev: 6c13bce3cbdd576463f5e3b1e61ab6f4046e47c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: [YOCTO #1025] build system for docsBeth Flanagan2011-06-131-0/+84
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>