summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
AgeCommit message (Collapse)Author
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: 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: 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: 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/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/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-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-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-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-17documentation/dev-manual/dev-manual-common-tasks.xml: Fixed referenceScott Rifenbark
Caught and fixed a stray reference to "appendix" that should be "chapter." (From yocto-docs rev: 97d26495dd9b561bb5724a86e9cd777eeef9f71a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: converted ref-variables-gloss to chapter.Scott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-varibales-gloss" appendix to a chapter and made sure any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 3f541c20c7aff1012eb4c06cb856bf9795124822) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: converted ref-images and ref-features to chaptersScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-imagese" and "ref-features" appendices to chapters and made any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: Fixed the links to the BitBake Documentation page.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ddee80872afc567b9381387980f257b337f29ea1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/dev-manual/dev-manual-common-tasks.xml: Added external SCMScott Rifenbark
Added the section "Using an External SCM" to the "Common Tasks" chapter. This information was formerly in the YP Reference Manual in the old development chapter. (From yocto-docs rev: d34cd9e86cb7a6b27cf6a5b4daf58c445dd86331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/dev-manual/dev-manual-model.xml: Added devshell sectionScott Rifenbark
I inserted the section "Using a Development Shell" into the "Common Development Models" chapter. This information was formerly in the YP Reference Manual and is being moved out to help the ref manual become a truer reference manual. (From yocto-docs rev: f4ca1c567afcebbae119f21c147e3c38c7ffd54e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04documentation/dev-manual/dev-manual-newbie.xml: Edits to submitting changeScott Rifenbark
Fixes [YOCTO_#2671] Added a bit more in here about considering requesting rights to have a contrib area to YP and OE if user is a regular and significant contributor. (From yocto-docs rev: b54bba33b2706bed593a9ee66d5c72f820c37d32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04documentation/dev-manual/dev-manual-newbie.xml: edits to sending patchScott Rifenbark
The section that describes how to send a patch upstream via email did not have a good connection to the various mailing lists. I added some references to this section and also mentioned using the scripts if the user has many changes to commit. (From yocto-docs rev: ad75ae45420c43bda974d22b02094237b5c7cc50) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04documentation/dev-manual/dev-manual-newbie.xml: Fixed typo.Scott Rifenbark
(From yocto-docs rev: d1ca036f11203f842eb87a204487c414ee901818) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04dev-manual: menuconfig now works properlyPaul Eggleton
Bug 2256 is now fixed in master and the fix will be in the next release, so update the documentation accordingly. (From yocto-docs rev: 877a7ecfd1623417d0793a5dd16b66c35b6fdbae) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04shared state memory -> shared state cachePaul Eggleton
"shared state cache" is the generally accepted term for this. (From yocto-docs rev: a15f629afe46e7217182a1ac077ab59641be9a8c) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04dev-manual: correct SMP_CONFIGPaul Eggleton
It's CONFIG_SMP here, and since the title of the section already mentions it, just change the sentence to be more generic. (From yocto-docs rev: 32e6145b5f41d4eb293f8267ef01d02217143152) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04dev-manual: tidy up "How to Submit a Change" sectionPaul Eggleton
* Change some of the language and patch submission directions to correctly represent how we work together with OpenEmbedded (this changed with the introduction of OE-Core a few releases ago). * Correct --help option to -h for pull request scripts * Clarify commit message guidelines * Touch up a few other bits and pieces Fixes [YOCTO #2671]. (From yocto-docs rev: 3170ce5e0757951afee13207c117316e33449b39) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03documentation/dev-manual: Fixed "Linux Yocto" termScott Rifenbark
Throughout the manual, the kernels that are built and available through the Yocto Project were being referenced as a "Linux Yocto kernel." This reference is poor. First, it placed Linux and Yocto very close together and could upset the Linux folks. Second, a better way would have been to say "Yocto Linux kernel." I have fixed by referring to kernels that are available through the Yocto Project as "Yocto Project kernels." (From yocto-docs rev: 9b8319328cd4ab4ce3363001c9feeec585d9cab9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03documentation/dev-manual: Scrub for Yocto Project termScott Rifenbark
I have replaced the term "Yocto Project" with more appropriate terms where possible. (From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03documentation/dev-manual/dev-manual-bsp-appendix.xml: Yocto term scrubScott Rifenbark
Scrubbed the manual for the term "Yocto Project", which has been over-used. I updated occurrances to better represent actual bits rather than generically referring to everything as Yocto Project. (From yocto-docs rev: f70cffeffa0d8863a88783607621bf6f7125d02d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-28documentation/dev-manual/dev-manual-kernel-appendix.xml: Added branch stepScott Rifenbark
The example did not specify to switch to the "denzil" branch after establishing the local repo of poky-extras. The example will not work without this step. (From yocto-docs rev: 90071570bca2edfceb4adb91bdd9093c095c8825) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-26documentation: Re-defined "Build Appliance" to mean the fileScott Rifenbark
Previous renditions of the term "Build Appliance" referred to the VMware system. However, it was determined that the term "Build Appliance" should really refer to the actual image that can be booted and run on the VMware applications. I have updated the areas affected by this change. The change assumes the name of the built or downloaded file you boot will be named "build-appliance-image." Fixes [YOCTO_#2656] (From yocto-docs rev: 6b27b7d92b9722351eb43a7c2a341ce3af056dba) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-21documentation/dev-manual/dev-manual-newbie.xml: Typos fixed.Robert P. J. Day
Typoes/fixes to chapter 3. (From yocto-docs rev: 5cf906df6ae8a729a8f10510a89e570ed9d900e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-21documenation//dev-manual: Typos fixed.Robert P. J. Day
Some minor typoes in first couple chapters (From yocto-docs rev: 36618cc6a261a994b00c5c524c76cbf3952a2eae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-21documentation/dev-manual/dev-manual-common-tasks.xml: Moved dbg and profileScott Rifenbark
Moved the sections on remote debugging and using the profile out of the YP Reference Manual and into the YP Development Manual. These are now two sections in the "Common Tasks" chapter. (From yocto-docs rev: 42640bf69aa05c56eb112c10b6d7b96069173785) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/dev-manual: Moved temp source code mod into dev modelScott Rifenbark
The section "Modifying Temporary Source Code" that was in the chapter for "Common Tasks" was moved to the "Common Development Models" chapter. After discussion with Darren Hart, modifying temporary source code is a valid develop model. So, rather than isolate it in the common tasks chapter it has been placed in the development model chapter, which now has four types of development. Changes were made to update the introductory text of all the concerned areas of the manual. (From yocto-docs rev: 8b07ee3bcda9c13e576b54b0079b0656cd8fcc32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/dev-manual/dev-manual-start.xml: Updates to pre-built sectionScott Rifenbark
The "Using Pre-Built Binaries and QUME" section needed to incorporate some information from the YP Reference Manual. I have merged those changes in and did some re-writing to blend it well. (From yocto-docs rev: 5c20f00f9ec75c19fd0106c9f241751381ba7e3c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31documentation/dev-manual/dev-manual-kernel-appendix.xml: Comments removedScott Rifenbark
I removed two larges sections of old comments. (From yocto-docs rev: df1b08b621f2b449c7575b86ec90c40f1606c43d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>