summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Fixed anchor tag and added doc step for bug filing.Scott Rifenbark2013-10-081-1/+5
| | | | | | | (From yocto-docs rev: 064915db0fac0a752b397c3b5ceec0fca6f91e3d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: updated the example list of branches for poky.Scott Rifenbark2013-10-081-3/+3
| | | | | | | (From yocto-docs rev: 59723e825049853585469cc10bdd21cd8451a5a1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, mega-manual: Updated downloads figure and some links.Scott Rifenbark2013-10-081-7/+6
| | | | | | | | | | Found a couple broken links. Also, noticed the yp-download figure was out of date. Especially in the Figures folder of the mega-manual. (From yocto-docs rev: 2e55faca221186d157dd5f77d048f1b2b90d5d91) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added the memory-resident BitBake featureScott Rifenbark2013-09-121-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | The main changes are captured in a new section devoted to the oe-init-build-env-memres script within the ref-structure.xml file and in the variables.xml file in a BBSERVER variable entry in the glossary. All other changes were necessary to integrate the new functionality into areas where running the setup script are discussed. Before this feature, there was a single setup script (oe-init-build-env). Consequently, wordings and such were designed exclusively for this single method. With the introduction of a second possible method to initialize the build environment, tweaks to many sections were needed. Beside the wording tweaks, appropriate cross-referencing was also needed. All these changes cover the integration of the new feature. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual, yocto-project-qs: Debian support addedScott Rifenbark2013-08-131-1/+1
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #4912] Throughout the manual set, various areas talk about the Linux distributions we support and the required packages among other items that are tied to a distro. Debian had been missing except from the list in the ref-manual that shows the releases we test against. I have attended to all areas where Debian needs to be mentioned now. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 2004567821add745d320106b0dc6cccb4f73b605) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed some rogue characters.Scott Rifenbark2013-08-131-2/+2
| | | | | | | | | | | Discovered a random ":S" and ":" character in front of a couple of list items. Must have been a wandering cursor situation during an edit session. (From yocto-docs rev: b81412e255ca90e850bce61ef7f9927692f0fcb5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed reference to bug format.Trevor Woerner2013-08-131-1/+1
| | | | | | | | | | Based on observations from the various mailing lists, it is obvious that bugzilla issues are almost always referenced using square brackets. (From yocto-docs rev: 10b51afe7db62b8eb6e29bd1dd1ba4edb4320f83) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to the "Cross-Development Toolchain" term.Scott Rifenbark2013-06-211-90/+25
| | | | | | | | | | | | This term description has been reduced to an introduction only. The real details are now in the ref-manual. This term now simply is introduced and the reader is referred to the ref-manual section. (From yocto-docs rev: 4d53a25e1871d793d5c38eba4d1f8715c989cb4d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: partial update to cross-development toolchain definition.Scott Rifenbark2013-06-211-34/+71
| | | | | | | (From yocto-docs rev: 3a6f396c09a6d6a4e8a7fe9316b57166488d7fee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added definition for the term "Meta-Toolchain"Scott Rifenbark2013-06-141-1/+6
| | | | | | | | | | The definition simply states it is sometimes used for "Cross-Development Toolchain". (From yocto-docs rev: 477c2f88694feb148111dc69907945d267056eaf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to the term "Cross-Development Toolchain"Scott Rifenbark2013-06-141-22/+31
| | | | | | | (From yocto-docs rev: 80fcb3ce0a7d91dff2cb09dc5267528cfb6548ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated reference to where licenses are keptTrevor Woerner2013-06-141-1/+1
| | | | | | | | | | | After a build, the license data is found in ${TMPDIR}/deploy/licenses not ${TMPDIR}/deploy/images/licenses. Reported-by: Trevor Woerner <twoerner@gmail.com> (From yocto-docs rev: 7f9b3d842f0f68bd0c005a20d38f1b26aef11387) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated wording about GitScott Rifenbark2013-05-311-54/+54
| | | | | | | | | | | | | I removed the statement saying that checking out a Git repository is a backup of the repo. Technically, that is not true. It would be more of a clone operation. The statement was superfluous anyway so I decided to remove it altogether. Reported-by: Trevor Woerner <twoerner@gmail.com> (From yocto-docs rev: 081bd0119f8c17a3932485857b6846dcb6998ee1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added cross-reference to section for finding maintainersScott Rifenbark2013-04-171-3/+10
| | | | | | | | | | | | | The "Tracking Bugs" section mentions how to enter a bug using Bugzilla. I added a new step just before the step that says to submit the bug that tells the user to be sure to copy the correct people. The link goes to the section that describes how to figure out who is responsible for code. (From yocto-docs rev: 64e58402490267a339c9bade969850da50f39cf1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added methods to determine who a Maintainer is.Scott Rifenbark2013-04-171-0/+40
| | | | | | | | | | | | | | | Provided three ways to dig out the information on who might be contaced about a change or patch to an area of code: 1. See the "maintenance.inc" file. 2. Examine BSP README files or the MAINTAINERS file (for BSP) 3. Use the 'git shortlog -- <filename> command to see who has committed the bulk of the changes for a particular file. (From yocto-docs rev: 0757a2edddb55bcce2ea1507501220c3097f0a22) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Using Email to Submit a Patch" section.Scott Rifenbark2013-04-101-10/+16
| | | | | | | (From yocto-docs rev: 9662debc970e3c1db84a9831760174e57b9c48ce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "How to Submit a Change" section.Scott Rifenbark2013-04-101-7/+8
| | | | | | | (From yocto-docs rev: 8b9cff0c35eb76665edca6c8474935d6dc62e7ed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Tracking Bugs" section.Scott Rifenbark2013-04-101-4/+4
| | | | | | | (From yocto-docs rev: 2b87ec45a39929e1046b259b77d9ebf022e45242) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Workflows" section.Scott Rifenbark2013-04-101-20/+24
| | | | | | | (From yocto-docs rev: 6b076afb92454b8a7279f747a78bbf565a93c09d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Basic Commands" section.Scott Rifenbark2013-04-101-12/+15
| | | | | | | (From yocto-docs rev: 3cd5c68d610d7ec2fe4c8d1ad64b05833bb31425) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Repositories, Tags, and Branches" section.Scott Rifenbark2013-04-101-13/+15
| | | | | | | (From yocto-docs rev: 6ab8d6441d53871b2e0a7163a31b1505a86872b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Git" section.Scott Rifenbark2013-04-101-1/+1
| | | | | | | (From yocto-docs rev: d9df3683831253bfb63f764c95531d341aea2dbd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Licensing" section.Scott Rifenbark2013-04-101-2/+2
| | | | | | | (From yocto-docs rev: e04a9b4d04872a753ec81e1c4600ee3189d667c0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Yocto Project Terms" section.Scott Rifenbark2013-04-101-28/+29
| | | | | | | (From yocto-docs rev: d5742f17daccbaab752e9c82f12dbc9b166bb901) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Yocto Project Source Repositories" section.Scott Rifenbark2013-04-101-7/+10
| | | | | | | | | | | Some minor text editing. Also, updated two figures to be more recent. One for the Index of Releases and one for the YP Downloads page from the website. They were very dated. (From yocto-docs rev: 59255d7c0175a5280239d070ce902079229cf909) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Summary" section.Scott Rifenbark2013-04-101-3/+3
| | | | | | | (From yocto-docs rev: 6c73cc0e01ed10c225eb054eb5ea5a26b989bbdb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Policies and Change Flow" section.Scott Rifenbark2013-04-101-2/+2
| | | | | | | (From yocto-docs rev: 9d4c4fdaec73a0bba3e19872cad24a8c2463da58) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Autobuilders" section.Scott Rifenbark2013-04-101-8/+8
| | | | | | | (From yocto-docs rev: 5facb63e7bd0bb9627e83cfc34ae82a3898fe349) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Source Control Management (SCM)" section.Scott Rifenbark2013-04-101-1/+1
| | | | | | | (From yocto-docs rev: 8e2290f43f37e39ef3aa97e97b73f15978ca1076) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Some edits early in Chapter 3.Scott Rifenbark2013-04-101-3/+8
| | | | | | | (From yocto-docs rev: 566af2c28413eeb89b69a59fab087e0145a9493e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Core System Development" sectionScott Rifenbark2013-03-221-0/+11
| | | | | | | | | | | | | Added a new bullet as a tip for best practices that addresses how we address bug 3071 and 3274. We are suggesting they enable a PR Service if they are using continually incrementing PR values when package feeds are published or used. Reported-by: Richard Purdie <richard.purdie@linux.com> (From yocto-docs rev: b90497f139b1b6f7ab5510313eb297d5d7fb4e68) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review comments applied for "Working in team" sectionScott Rifenbark2013-03-021-1/+1
| | | | | | | | | | | Fixes YOCTO #3274 Re-wordings per Dave Stewarts review comments. (From yocto-docs rev: 1d8fbc557388e9b86274e58d04cc6e70193e500c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review comments added to "Working in Team" sectionScott Rifenbark2013-03-021-9/+15
| | | | | | | | | | | | | Fixes YOCTO #3274 Applied several recommended changes for the section describing best practices when using YP in a team enviornment. these changes were from Dave Stewart. (From yocto-docs rev: 7efc9864dc6757e3cf5c026f3c1785e5947cbfec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to the "Working in a Team Environment" section.Scott Rifenbark2013-03-021-14/+20
| | | | | | | | | | | | | Fixes YOCTO #3274 Applied various review edits from Richard Purdie. Additionally, I ran a spell-check on the chapter and caught some typos. I fixed these as necessary. (From yocto-docs rev: 794a13d26bb7a9e268b16f809158a6af58cc3ce8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Revision of "Team Environment" section.Scott Rifenbark2013-02-141-86/+308
| | | | | | | | | | | | | | Fixes YOCTO #3274 First draft of a re-written section that describes best practices for scaling the YP over a large development effort. this draft is based on Richard Purdie's text he sent to me. (From yocto-docs rev: e5135f76946997a0a060dd16c0b62308be4f6048) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to expose cross-toolchain recipes.Scott Rifenbark2013-02-141-7/+51
| | | | | | | | | | | | | | | | | Added a bulleted list to the "Terms" section to help define some toolchain recipes such as gcc-cross-initial, gcc-cross-intermediate, and so forth. Added a cross-reference link to the term "Cross-Development Toolchain" in the the "Working Using Stand-alone Cross-development Toolchains" section. This gives the reader a way to see more on the toolchain recipes. (From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Metadata" term.Scott Rifenbark2013-01-271-3/+8
| | | | | | | | | | | | In the "Terms" section, I enhanced the "Metadata" term to include a bit about Metadata in the context of the kernel. This type of metadata is discussed at length in the YP Linux Kernel Development Manual. (From yocto-docs rev: c6f48bc4c33850eaa1dbf5867759a19d373766ce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Various fixes for links, typos, and grammarRobert P. J. Day2013-01-071-6/+6
| | | | | | | | | | | | 1. Added "Debian" as a distribution for best results. 2. Fixed a link to the Hob page and two links for the Build Appliance. 3. Three typos fixed and a few grammar items fixed. (From yocto-docs rev: 0b381094ed9cc2d66895d4ad7c63005c8a918eb1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Removed all trailing whitespace.Scott Rifenbark2012-12-111-424/+424
| | | | | | | (From yocto-docs rev: d117584a589460412a7fc4df15512b0d9c9448c7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: dev-manual - Fixed maintainer link.Robert Cochran2012-12-111-2/+2
| | | | | | | | | | I updated a note that points the reader to the maintainers list. The note in the master branch pointed the reader to a nonexistent (old) file. (From yocto-docs rev: d947d6d9bd42562a84ad3ac90e4c2052f421119c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updated collaboration sectionScott Rifenbark2012-12-031-2/+36
| | | | | | | | | | | | | | | | Fixes [YOCTO #3274] I have added a new area at the bottom of the current "Using the Yocto Project in a Team Environment" section. This section is the spot for addressing what Richard Purdie coined as "How to use YP in a work group." For now, the changes are based on the information that Richard placed in the Bugzilla entry. Presumably we can build on this information. (From yocto-docs rev: 92c5d1b6ac6b553fab19410170364dca40123c59) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: several manuals - Notes and links for filename space issueScott Rifenbark2012-12-031-2/+7
| | | | | | | | | | | | | | | Fixes [YOCTO_#3396] Spaces in file and directory names is an issue for the build system and throws an error when sourcing the environment setup script. I added key notes in several areas of the doc set. I also added some cross-references to the oe-init-build-env section in some other areas where running the script is discussed. (From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Final changes before 1.3 lockdown.Scott Rifenbark2012-10-231-23/+29
| | | | | | | | | | Made minor changes as needed due to some new sections, links, and capitalization standards. (From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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-041-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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-12 10:45:17 +0000