summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2012-09-04yocto-docs/.gitignore: Final fix to ignore mega-manual.Scott Rifenbark
I think I got it right this time... sheesh. Had the wrong file suffix in there for the .tgz file. (From yocto-docs rev: d5931252ede475846dcb61fc0e0f03eb7fe4015e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/yocto-project-qs/yocto-project-qs.xml: removed fakerootScott Rifenbark
Fixes [YOCTO #3036] Turns out the fakeroot package is not required for the Fedora Linux distribution. I removed this to reverse the fix I did earlier for YOCTO #3036. (From yocto-docs rev: 6b22dda7fc7f07bd34d2a84e03308ae8ebcfbe9b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/poky-ref-manual/ref-variables.xml: TCMODE editsScott Rifenbark
Minor wording changes. (From yocto-docs rev: 2744ef171c4454ce66aee240963c34bc326f1c07) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/yocto-project-qs/yocto-project-qs.xml: added and removed packagesScott Rifenbark
Fixes [YOCTO #3036] Added fakeroot to the Fedora package list. Removed python-curses package from the Fedora package list. Added python-curses package to the OpenSUSE package list. This fixes a previous commit where I accidentally added python-curses to Fedora. (From yocto-docs rev: 8e1b7a640886e6d39cf1e175611098555204a5f3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/yocto-project-qs/yocto-project-qs.xml: added python-cursesScott Rifenbark
Fixes [YOCTO #3036] I added the python-curses package to the list of required packages for the Fedora distribution. (From yocto-docs rev: 2929a0f97cd9be88580c0a80848b7fff327b4642) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/mega-manual: New mega-manual directoryScott Rifenbark
This new directory contains the files for the mega-manual HTML document. Mega-manual is a compilation of all the existing YP manuals and guides. It is a single HTML file that simply lists each individual HTML document for the existing YP manuals and guides. The figures directory contains all the figures (duplicated) from the individual manuals and guides. (From yocto-docs rev: 5620c20ea4c7c69c96601b7480471e6166fd9409) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/tools/mega-manual.sed: Processes external links in mega-manualScott Rifenbark
Added this file to the tools directory. It is used from the Makefile when making the mega-manual. The file processes all the appropriate <ulink> tags so that they are converted to <link> tags and the user is not vectored off to an external HTML file. (From yocto-docs rev: da2ad62a160c22f785e8237439494716e4c023cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual-newbie.xml: Edits to email patch sectionScott Rifenbark
I updated the section that describes how to submit a patch through email while not using the scripts that send patches and request pulls. (From yocto-docs rev: 9167b89289134d8d16610cc527d0d71713c0641b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Section change for using email to submit patchScott Rifenbark
Changed the title and a single reference from the Kernel manual to a title more representative of how these patches are sent - not using scripts. (From yocto-docs rev: ff908c34fae88eab9724891a008142a834f34081) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual-newbie.xml: Updates to submitting patchesScott Rifenbark
I added text to indicate that using the two scripts for generating patches and requesting pulls is the preferred method to send a patch. (From yocto-docs rev: d6f036a91074dd00c51fe0f937224182fc801b3b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Section Heading change for pushing commitsScott Rifenbark
Changed the section heading for the part describing how to push changes upstream via the poky scripts. Also had to change one cross-reference to the section in the kernel manual. (From yocto-docs rev: be7712aba044238e8781cdf869c5d14e77eb09a2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual-kernel-appendix.xml: Fix PARALLEL_MAKEScott Rifenbark
Every place in the YP documentation suggests setting BB_NUMBER_THREADS and PARALLEL_MAKE to twice the number of cores as the host machine. This fixes a single instance in the YP dev manual where it was suggested that PARELLEL_MAKE be set at 1.5x times the number of cores. (From yocto-docs rev: b6b820371cbe43e39425156c72c45df283fdf7d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/README: Updates for mega-manualScott Rifenbark
Added information about the mega-manual. (From yocto-docs rev: bbf75682f957ad2e124aa9476f52cd2bd3829fa6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/Makefile: Added mega-file, comments, and publish testScott Rifenbark
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-09-04documentation: Title changesScott Rifenbark
Removed "The" from all the titles of the books. This makes it easier to reference to them and easier for the automated processing of the mega-manual. (From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual-model.xml: Fixed mis-named guideScott Rifenbark
I fixed a reference to a manual that should have had "Guide" and not "Manual" (From yocto-docs rev: a51de96fe0cd78cb379e6758d7e357c91daa2791) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Manual reference fixes for mega-manual processingScott Rifenbark
I fixed several occurences of cross-references to whole manuals where the formatting was split in the <ulink> statement. The <ulink> tag and the manual title must be on one DocBook line in order for the sed scripts to correctly process the links when the mega-manual is created. (From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual: Title FixesScott Rifenbark
Fixed several references to books. There should be no books referenced using "The" at the beginning of the manual title. These need to be "the" in order for correct mega-manual link processing with the sed script. (From yocto-docs rev: 76753216c7138d55f7b6f9167d678245ab3134e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/bsp-guide/bsp-guide.xml: Fixed titleScott Rifenbark
the title in the note about production process was technically wrong. I added in "Yocto Project" as part of the title. (From yocto-docs rev: c421f02549b8ca203d1c9f747870911c59bda96c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Fixes to note for mega-manual processingScott Rifenbark
the notes that say "Due to production processes..." at the start of each manual contain links to manuals. the links needed to be formatted such that the entire <ulink> code and manual name appeared on the same line so that the sed script can effectively remove the link in the resulting mega-manual. (From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual.xml: fixed so mega-manual worksScott Rifenbark
I moved "the" outside of the generated HTML link so that the sed script will process this part of the manual correctly for the HTML mega-manual. (From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Fixed references to the YP Dev ManualScott Rifenbark
The references to the YP Development Manual were inconsistant. These references were fixed. (From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: fixed Quick Start referencesScott Rifenbark
The way I refered to the YP Quick Start was inconsistant. I have made edits to remove these. (From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/Makefile: Changes for new style sheets and mega-manualScott Rifenbark
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-09-04documentation: Style sheet naming changesScott Rifenbark
I had to rename individual style.css sheets to have book-specific names. So style.css for the ADT manual becomes adt-style.css and so forth. Turns out, this isn't really necessary for the solution to create the mega-manual but I am leaving the changes as a separate commit because it makes sense. It causes no disruption to making the six YP manuals. (From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/yocto-project-qs/yocto-project-qs.xml: File name changedScott Rifenbark
For some odd reason the PNG filename for the YP logo did not end in "p". I added the character so that the image is displayed. (From yocto-docs rev: a6a4bcf9798be2bbf1be3922226ef83b7d6667d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: tag change adt and kernel manualsScott Rifenbark
I changed a couple of id strings so that they are not duplicates. I did this to eliminate a make error while experimenting with creation of the single HTML YP document comprised of the individual docs. Changing the id strings has no consequence on the individual Application Developer's Guide and Kernel Manual. (From yocto-docs rev: 4e6832eca319a637be693dfe67ee56c540dfddfa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/kernel-manual: Fixed minor problemsScott Rifenbark
I did a read-through of the manual and spotted several nits that I fixed. All these are minor fixes. (From yocto-docs rev: 0c8f9c660ecea0b36e2b6af0315d3d239f70a688) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/dev-manual/dev-manual-start.xml: Updated NFS server/QEMU infoScott Rifenbark
Changed the first sentence of the description of how to use QEMU images with NFS server. This is feedback from Scott Garman's review. (From yocto-docs rev: 6a33b1b58bd72756baf57228b7348ff662248012) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Added install and config steps for Juno 4.2Scott Rifenbark
Fixes [YOCTO #2929] Provided an updated section on how to install and configure the Eclipse IDE so that it supports both Juno 4.2 and Indigo 3.7.2. The fix included creating a new poky.ent variable that is Juno-specific. (From yocto-docs rev: 6b0b046322420f56feb644eb6de8341dfac59df2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-15documentation: remove references to PimlicoRoss Burton
(From yocto-docs rev: f834df81cd8976f4710c1d3830c9384261f7500c) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-14documentation/poky-ref-manual/ref-structure.xml: deleting imagesScott Rifenbark
Added clarification on how a user can hand-delete images from the build/tmp/deply/images directory. (From yocto-docs rev: 4655085d43b36b024a2e01cfcc7455e18d891ab8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-14documentation/dev-manual/dev-manual-common-tasks.xml: Packages dir removedScott Rifenbark
Updated an old comment in the layers.conf file example to say we have recipes-* directories instead of the old packages directory. (From yocto-docs rev: c39394e848d6039e6728b7e53de86958f951e258) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-14documentation/dev-manual: modified SSH server discussion for QEMU ImagesScott Rifenbark
Two areas of the manual updated to reflect the fact that not all QEMU images have an SSH server in them. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: a173d8cb05ee695b02188a037ee047db016c6a67) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/dev-manual/dev-manual-intro.xml: typo fixed.Scott Rifenbark
(From yocto-docs rev: fc6fb25fd69b3af41692f482f768a63ee746d52f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/poky-ref-manual: Removed included BSP GuideScott Rifenbark
With the decision to create a single HTML file that has all individual YP manuals, the need for including the BSP guide as part of the YP Reference Manual goes away. I have removed this guide as a chapter, removed the mention of it in the introduction, and fixed the two links in the FAQ chapter to reference the external manual. (From yocto-docs rev: b0dbda9e09b73c2b26111bda118731dbb3090cae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/bsp-guide/bsp.xml: Fixed error in sample layer.conf file.Robert P. J. Day
(From yocto-docs rev: 9ea6fc5d2b9ede51668121421e448f9fffc7e7de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Updated the h6 style to use a larger fontScott Rifenbark
(From yocto-docs rev: 5fa8d627fe671f0eb7bbc67ce852e2010cbd723f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Moved the Eclipse chapter to the YP Dev Manual.Scott Rifenbark
The detailed chapter that describes how to install and configure the Eclipse Yocto Plug-in has been moved to become a subsection of the "Workflow" chapter in the YP Development Manual. This commit accomplished the bulk move, edits to integrate the information, and fixes to all cross-references. Moving the chapter creates a sectioning issue in the YP Development manual that results in subsections that are six levels deep. Not ideal. Will look at fixing these with a subsequent commit. (From yocto-docs rev: e6abff8f578f2cf6997895260f607395281ae8e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Changes to ADT Manual titleScott Rifenbark
The name of the ADT manual has changed to the "Yocto Project Application Developer's Guide." This change had some ripple effect regarding cross-references into the manual. These are now fixed. (From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation/dev-manual/dev-manual-model.xml: Edits for Eclipse insertionScott Rifenbark
In preparation for taking the Eclipse installation and configuration steps, I have made an edit pass through the section "Workflow Using the ADT and Eclipse". Minor edits performed to integrate the new information. (From yocto-docs rev: 7b4e0ae371b23f329451ac768b7d9eab5931df2d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation/kernel-manual/kernel-doc-intro.xml: Fixed typoScott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ef6888dffa95e1fbf74dd80e48034f3591a32959) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-22documentation: Created cross-references to new KMACHINE glossary itemScott Rifenbark
With the creation of a new KMACHINE glossary item, there were two areas in the YP doc set that reference the variable. I added cross-reference tags. Also noted that some other references were missing to the variable COMPATIBLE_MACHINE. (From yocto-docs rev: f740b62be175a50f17ce8a244258dcf391fcf672) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-22documentation/poky-ref-manual/ref-variables.xml: New KMACHINE gloss entryScott Rifenbark
Created a new glossary entry for the KMACHINE variable. I used Bruce Ashfield as my resource for understanding this variable. (From yocto-docs rev: 1069ddb3fe0b3bd00ba651b51419354258ae57d3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-20documentation: Config fragment sections updatedScott Rifenbark
I have updated both the section for configuration fragments found in the BSP and dev manuals. Reported-by: James Abernathy <jabernathy@gmail.com> (From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-19documentation/poky.ent: updated YOCTO_DOCS_RELEASE variable to 1.3Scott Rifenbark
We should not use "latest" any longer for this variable. The string is fine in URLs that might appear on a website but the actual variable should be set to the release number. This way when we go to release the version of the docs they do not have to be reset with a post-release commit to change the variable from "lastest" to "1.3". (From yocto-docs rev: f97122847e65c223173fabb793ef1ddb04605e62) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-package.xml: Edits to packaging chapterScott Rifenbark
Some minor edits to create some links to some terms used. (From yocto-docs rev: 1559b8caca07cce8630de9ddf8c84f0b24fa35e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-prepare.xml: Edits affecting rename and clarityScott Rifenbark
I made a pass through this chapter and focused on better descriptions for getting the system ready for application development. I made adjustments to better represent what is really being done. It is not all ADT here as was being described before. Miscellaneous edits and improvements throughout. (From yocto-docs rev: 3544beda4794005fe139d7620fd13618fab05534) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-intro.xml: Edits to introduction chapterScott Rifenbark
I edited the text so that the purpose of the manual is clearer. I have segmented out the ADT into distinct components and made sure the overviews of each is good. Edits to clarify the role of the ADT as well. (From yocto-docs rev: c4abd8305dcdba986f1e761887c740e8322bb331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-manual.xml: Title change for link.Scott Rifenbark
(From yocto-docs rev: 4b34f9e53230b792a7f57f2880177299286d057d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>