summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: dev-manual - Typo fixed.Paul Eggleton2012-10-151-1/+1
| | | | | | | (From yocto-docs rev: f64babca3cce710718bbc6b4199ae6ad4002d209) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: bsp-guide, dev-manual, kernel-manual - Removed linksScott Rifenbark2012-10-101-4/+3
| | | | | | | | | | | | Removing the Appendix A (BSP) example had some rippling affects throughout the doc set. There were several links into the appendix. All these links had to either be modified (if possible) or simply removed since the appendix will be removed. (From yocto-docs rev: fff35abd87e945de1806eef63a56a956d104bf92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: poky-ref-manual, dev-manual - added link to oe-corePaul Eggleton2012-10-021-1/+1
| | | | | | | | | | | | | | | | * Explain that we test with a set of reference hardware rather than only supporting hardware that we have (avoiding any implication that the build system can't support other devices). These are in the faq entry in the poky-ref-manual for the question of how we can claim Poky / OpenEmbedded-Core is stable. * Adjust the language so that it is OE-Core friendly, with a link to the Development Manual for the definition of OE-Core. (From yocto-docs rev: 5ff1604dd383b26e918c319fcbe46dd1589cebc5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Better description of location of scriptsScott Rifenbark2012-10-011-2/+2
| | | | | | | | | | The description for where the "scripts" directory lives was not conforming to our terminology. (From yocto-docs rev: 925167c446b86ca09d387d01568db64113412311) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - wording change to remove ambiguity.Scott Rifenbark2012-10-011-1/+2
| | | | | | | (From yocto-docs rev: 01fc1959efa85fdba17beec4a5c565108c6ab68a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - formatting change.Scott Rifenbark2012-10-011-1/+2
| | | | | | | (From yocto-docs rev: 8d43e7ff1ad8151a09e12524d9b9afe825322954) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Buzilla components updated to six.Scott Rifenbark2012-10-011-2/+3
| | | | | | | (From yocto-docs rev: 28480c246f0346d16424837d6be5d45e084e15c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - better wording.Scott Rifenbark2012-10-011-1/+2
| | | | | | | | | For obvious reasons I changed this one :) (From yocto-docs rev: 5f3203292f46bea799321e4520668252a46fb599) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Added link to pull scripts.Scott Rifenbark2012-10-011-1/+5
| | | | | | | (From yocto-docs rev: 87fe511d4114295f8d67705c03ac11983f51cf7a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - added link to section on patching.Scott Rifenbark2012-10-011-0/+2
| | | | | | | (From yocto-docs rev: 6316ef2aa8947d64fb262824b9f57df0e3a8e1c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - better terminology.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: 06f1556d10c75134e53ade7bab407623f00b6a87) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - formatting fix.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: 24e653c02278d7a3d935104296f54cf9fff9ce12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - clarifies local branch.Scott Rifenbark2012-10-011-2/+2
| | | | | | | (From yocto-docs rev: fff80ac6e0a7092f19a268694f974ff45fb0fe8b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar fix.Scott Rifenbark2012-10-011-2/+3
| | | | | | | (From yocto-docs rev: eecdc407ae10a9c4146d79735e2e3fce7a031083) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - updated the key tags example list.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: 8bdbe16e97be04482d3b06c9cf63bdef6ab49d5a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Better wording for repo setupScott Rifenbark2012-10-011-3/+2
| | | | | | | | | | | I improved the wording such that it is not tied to a x.x type release. It is more generic here and will survive better under future releases. (From yocto-docs rev: 2bd644db7fef71cd2f07f6d3dcbd2ba60b83df08) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - updated string of example branches.Scott Rifenbark2012-10-011-4/+3
| | | | | | | (From yocto-docs rev: 79171c5c3c805178971ac099471d466e08968bbf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - Added "the" in front of YP use.Scott Rifenbark2012-10-011-2/+2
| | | | | | | (From yocto-docs rev: 0bb38edb5a1b855322da2afe2af57d627a573c51) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar fix.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: 0c6804e0c9c3721964f5780f6ce6d56ec813fd47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar fix.Scott Rifenbark2012-10-011-1/+2
| | | | | | | (From yocto-docs rev: 8611504763fe3d1e8fb95ceb06416e78203741b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - First re-write of "Package" term.Scott Rifenbark2012-10-011-2/+16
| | | | | | | (From yocto-docs rev: 735f6b10710f060541de88c9164c9cc1e605d436) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Added QEMU for image target.Scott Rifenbark2012-10-011-2/+2
| | | | | | | (From yocto-docs rev: 6dceb27dd5687e1a6a9ae3ad8decccbaa211376a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar fix.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: a601b39d93d036a0e54f5e4f0b8d0bb052c5ef98) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Fixed buildbot target heading.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: dc8949b3493b16d3a8ba83aad0ec756c53fcd1cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Toolchain corrections from tarball to .sh fileScott Rifenbark2012-09-141-6/+6
| | | | | | | | | | | | | For 1.3 there is not longer a toolchain tarball. Instead, there is a wrapper script that lets you install the tarball. This fundamental usage model change caused several ripples throughout the documentation set. I have changed wordings and examples to reflect the new paradigm. (From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to BitBake User ManualScott Rifenbark2012-09-141-3/+5
| | | | | | | | | | | | | | | | | | | | Robert P. J. Day pointed out a link in the development manual that was for the BitBake User Manual. The link resolved to an old, non-maintained version of BitBake documentation. According to Richard Purdie, the BitBake docs referenced should be the ones that ship in the bitbake/doc/manual directory of poky. The YP docs had been using a variable named BITBAKE_DOCS_URL that also resolved to the antiquated user manual site. Consequently, there were many links that needed fixed across both the YP Development Manual and the YP Reference Manual. Each of these references now points in general to the bitbake/doc/manual directory in poky for more information. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Edits to email patch sectionScott Rifenbark2012-09-041-13/+11
| | | | | | | | | | | 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>
* documentation: Section change for using email to submit patchScott Rifenbark2012-09-041-1/+1
| | | | | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: Updates to submitting patchesScott Rifenbark2012-09-041-1/+7
| | | | | | | | | | | 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>
* documentation: Section Heading change for pushing commitsScott Rifenbark2012-09-041-6/+6
| | | | | | | | | | | | 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>
* documentation/dev-manual: Title FixesScott Rifenbark2012-09-041-1/+1
| | | | | | | | | | | | 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>
* documentation: converted ref-images and ref-features to chaptersScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation: Fixed the links to the BitBake Documentation page.Scott Rifenbark2012-07-171-1/+1
| | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: Edits to submitting changeScott Rifenbark2012-07-041-1/+4
| | | | | | | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: edits to sending patchScott Rifenbark2012-07-041-2/+20
| | | | | | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: Fixed typo.Scott Rifenbark2012-07-041-1/+1
| | | | | | | (From yocto-docs rev: d1ca036f11203f842eb87a204487c414ee901818) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: tidy up "How to Submit a Change" sectionPaul Eggleton2012-07-041-60/+59
| | | | | | | | | | | | | | | | * 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>
* documentation/dev-manual: Scrub for Yocto Project termScott Rifenbark2012-07-031-90/+109
| | | | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: Typos fixed.Robert P. J. Day2012-06-211-8/+8
| | | | | | | | | 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>
* documentation/dev-manual/dev-manual-newbie.xml: Tag example fixedScott Rifenbark2012-05-011-3/+3
| | | | | | | | | | | | | | The example that creates a local branch based on a release tag in the "Repositories, Tags, and Branches" section was not optimal. Darren Hart informed me that naming a local branch the same name as a tag confuses Git. Plus, the "-b" option was mis-placed. Renamed the local branch to have "my-" in front of it and moved the "-b" option earlier in the command. (From yocto-docs rev: 29f4ea267ef687431e09eca4634fcb6cc48a6f81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Fixed branch exampleScott Rifenbark2012-05-011-1/+1
| | | | | | | | | | | | | The example in the "Repositories, Tags, and Branches" section that creates a local branch that tracks the upstream branch is incorrect. The syntax should be "git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; Fixed it. (From yocto-docs rev: ec80d43ad97370771c9cd7f7e6a4637db5f80e9b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Link added for TOPDIRScott Rifenbark2012-05-011-1/+2
| | | | | | | (From yocto-docs rev: 56d07f8251b78ae8cef3a78836b16eccb2849b89) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Replacements for "1.1" and "edison", etc.Scott Rifenbark2012-04-231-1/+2
| | | | | | | | | | | | | I did a quick and dirty scrub over the manuals for the strings "1.1" and "edison". I found some instances that were not properly variablized. Also, discovered some references to the linux-yocto-3.0-1.1.x. All but one instance of this needed changed to linux-yocto-3.2. (From yocto-docs rev: 620fb4b7626defcefc8a039de09ae4599ee7f454) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Added to append termScott Rifenbark2012-03-231-4/+13
| | | | | | | | | I added more information to the YP Term "Append Files." (From yocto-docs rev: e1a7e9b0a790d394e237a0972140107d11178408) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Converted to use poky.entScott Rifenbark2012-03-231-73/+56
| | | | | | | | | | | | | I converted the hard links to use the variables as established in the file poky.ent. Also, Cleaned up some bad text in the term "Yocto Project Files." Looks like a cut-and-paste problem. (From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Fixed typo.Scott Rifenbark2012-03-081-1/+1
| | | | | | | (From yocto-docs rev: be10660d8a0b08731e763dbe761bfbc2e00f9831) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Re-org of topicsScott Rifenbark2012-03-081-1/+70
| | | | | | | | | | | | | Several topics in the "Common Tasks" chapter really fit better in the "Newbie" chapter. I moved these sections out. I also combined information from the section on submitting changes from the "Common Tasks" and the "Newbie" chapter to live in the "Newbie" chapter only. (From yocto-docs rev: 90fa8c125e545c57a5a994dd59715b73c5c4882f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-newbie.xml: Fixed linkScott Rifenbark2012-03-081-2/+1
| | | | | | | | | Removed redundant link to manual. (From yocto-docs rev: 7e7bc327237cae2be3c67e5b711548a16c4d8648) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: New Layer section and metadata link anchorScott Rifenbark2012-03-081-2/+3
| | | | | | | | | | | | | | | | The change to the dev-manual-newbie.xml file was minor. I added a link anchor for the term "metadata." The change to the dev-manual-common-tasks.xml was extensive. I have added an entirely new section on layers called "Understanding and Using Layers." The new material has several sub-sections. Information was based on emails from Paul Eggleton. (From yocto-docs rev: 4fb34abd60180fc2482ddb9f62e476763cee7679) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Added anchor point and edits to kernel configScott Rifenbark2012-03-081-1/+1
| | | | | | | | | | | | | I added a reference anchor to the spot in the dev-manual for the "Yocto Project Source Repositories". Other changes were to the bsp guide and were general edits to the "Linux Kernel Configuration" section. (From yocto-docs rev: def35923199d48c879ff06a68f81b5cd28d55185) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>