summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
AgeCommit message (Collapse)Author
2012-05-01documentation/dev-manual/dev-manual-newbie.xml: Tag example fixedScott Rifenbark
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: 24ab16d18fb317efb86d2c4ddb2ac1a1449df519) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01documentation/dev-manual/dev-manual-newbie.xml: Fixed branch exampleScott Rifenbark
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: 7b47dd460f240a0d7f07edf2767bcad1ddc9d4c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01documentation/dev-manual/dev-manual-newbie.xml: Link added for TOPDIRScott Rifenbark
(From yocto-docs rev: e02c1762fadd22f6ffc06e91ac82ebb59a7a7f68) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Replacements for "1.1" and "edison", etc.Scott Rifenbark
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>
2012-03-23documentation/dev-manual/dev-manual-newbie.xml: Added to append termScott Rifenbark
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>
2012-03-23documentation/dev-manual: Converted to use poky.entScott Rifenbark
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>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Fixed typo.Scott Rifenbark
(From yocto-docs rev: be10660d8a0b08731e763dbe761bfbc2e00f9831) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual: Re-org of topicsScott Rifenbark
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>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Fixed linkScott Rifenbark
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>
2012-03-08documentation/dev-manual: New Layer section and metadata link anchorScott Rifenbark
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>
2012-03-08documentation/dev-manual: Added anchor point and edits to kernel configScott Rifenbark
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>
2012-03-08documentation/dev-manual: Fixed YP Build Directory TermScott Rifenbark
Throughout the manual there is a specific term to refer to the YP build directory: "Yocto Project Build Directory." This term was being loosely referred to and was not consisten in linking to the actual term definition in the Terms chapter. All this is fixed. (From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: three small correctionsScott Rifenbark
Put in the real link to the YP Source repositories instead of a click "here" thing. Put in a reference to the BSP Layer section from the term layer. Fixed a grammar type. (From yocto-docs rev: 6b3b63480f948dad2c5101deedb8deafad291728) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: edits to build dir termScott Rifenbark
I beefed up the definition for the term "Yocto Project Build Directory." I included the TOPDIR role and also expanded the discussion on how it is created and the control the user has over it. (From yocto-docs rev: d00f30708ccd5fb9e1fc3c8e5240e0ab7a892fe0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Added text anchorScott Rifenbark
(From yocto-docs rev: d316f9506e0f94ca7bf75f2bdedb509b327b2ded) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Edits to Git sectionScott Rifenbark
Last edits to the "Git" section and the bulleted item that defines the term "Yocto Project Files." These edits were from a review of Joshua Lock. Reported-by: Joshua Lock <joshua.lock@intel.com> (From yocto-docs rev: 57cbb06aac566e02bb2e2a1ad05c3ff6dbb0359c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual: Reference link clean-upScott Rifenbark
I made another pass through the document and cleaned up some mistakes and also removed redundant links to manuals where I had already provided a link to the specific section. (From yocto-docs rev: 5da8ffe100127f5fe4bfd2b478f177d6bef3a968) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Git section updatedScott Rifenbark
I split the Git section into a couple sub-sections. One talks about concepts and the other is the section on simple commands. Hopefully the concepts section now addresses the confusion people are having over branches, tags, etc. Also changed the definition of the term "Yocto Project Files" based on some input by Joshua Lock. (From yocto-docs rev: d76a9942dd12e6bd3ccba5331039477b26c02379) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual: Edits to clarify YP filesScott Rifenbark
These edits help explain the differences between local YP files created through a tarball extraction vs cloning a Git repository. (From yocto-docs rev: ed368800c3e9ece71d27d6d690f0ddc264a4c2da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual: Updates to index of releasesScott Rifenbark
Had to update the figure again and I updated the surrounding text. (From yocto-docs rev: ed0aea8ad3670aace1eb51ca7a72e75a4c129fba) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: Fixed broken link to GitScott Rifenbark
Found another broken link to the Git documentation. They must have changed this stuff up. So I set the link to point to the appropriate area in the Git Community Book. Talks about distributed workflows. (From yocto-docs rev: f81d6bbff20629b2b3af73ef53f471090b9d828b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual/dev-manual-newbie.xml: fixed broken linkScott Rifenbark
there was a link to some Git documentation referencing workflows that apparently had gone stale. I replaced the reference with a link to the Git Community Book. (From yocto-docs rev: 7a2cbe4c45eb9bb53d5ddbc014bd6005c2844d56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25documentation/dev-manual/dev-manual-newbie.xml: Updates to Bugzilla useScott Rifenbark
I updated the Bug Tracking section to include rudimentary use of Bugzilla for entering a new bug. Fixes [YOCTO #237] (From yocto-docs rev: 8f2702444812c9dc25195340acebbaae15cd59d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25documentation/dev-manual: Edits from Tom Zanussi.Scott Rifenbark
Tom Zanussi provided a review up through part of the "model" chapter. I have implemented his comments mosty verbatim. Reported-by: Tom Zanussi (From yocto-docs rev: 693d4fadd4b34ffef9953fb1850d381ff7c028a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25documentation: Changed all manual links to point to "latest"Scott Rifenbark
There are many references to YP documentation throughout the YP manual set. They used to have hard-coded links to the current release (e.g. yoctoproject.org/docs/1.1 for Edison). This created a situation where if you went to a document on the website and clicked on a external reference to another manual, you would redirect to the current manual on the website. Really, you would want to go to the latest manual, which is one that is under development. Changing the links to "yoctoproject.org/docs/latest" makes the tip of master, which is used for devloping the next release, always have references to the manuals being developed and not back to the stable released set of manuals. This "latest" and "current" scheme for the links is not perfect. What has to happen when the latest set of the manuals freezes and becomes the next stable release, all the links in the docs will need to be changed from "latest" in the URL to the new release number. So for example, all the "latest" occurences would need to be changed to "1.2". Then for the next cycle as development begins again, the links need to be infused with "latest" again. (From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08documentation/dev-manual/dev-manual-newbie.xml: Robert P. J. EditsRobert P. J. Day
Robert suggested some minor wording changes that are good. (From yocto-docs rev: 50822bc3722e2f3b0a73ed837842ddc5c7595c7b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08documentation/dev-manual/dev-manual-newbie.xml: Robert P. J. EditsRobert P. J. Day
Robert ear-marked some links to point to downloads.yoctoproject.org. He also made several wording changes that resulted in better language and in a couple of cases fixed incorrect subject/verb usage. (From yocto-docs rev: 9106619c4264c2669be041c1e6d6124e022ab2d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-14documentation/dev-manual: Fixed five broken links and removed noteScott Rifenbark
The restructuring of the web site where we store manuals broke some links that were cut-and-pasted in from older work. These slipped by me so not changing them would direct the user to a 1.0 version of the externally referenced manual rather than the 1.1 version. I also got rid of a visible "WRITER'S NOTE" in the document that was left behind. (From yocto-docs rev: 1508826312a2fe35e5d693821a4c7737baafcb2e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-06documentation: Fixed links for yocto-1.1Scott Rifenbark
After greping through the documentation directory, I addressed all the <ulink> statements that used to have yocto-1.0 in the URL. They are now yocto-1.1. (From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04documentation/dev-manual/dev-manual-newbie.xml: added information for licensesScott Rifenbark
I added the directory where the list of know licenses are in the YP files structure (meta/files/common-licenses). (From yocto-docs rev: 6a8db1a5ac653dbc8730e61293221c0b0890888d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual: Added TM to first Eclipse in chapters.Scott Rifenbark
(From yocto-docs rev: 0f8b655da637ebf7708bdfff1473707c9ea3b8ef) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual/dev-manual-newbie.xml: note for maintainerScott Rifenbark
Added a note indicating where you can find the maintainer for yocto code. Suggestion by Robert Berger. (From yocto-docs rev: 8e55cc4c460582964b0267b4f43c14e7100f17fe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual/dev-manual-newbie.xml: addes link to commit pageScott Rifenbark
I provided a link to the OpenEmbedded wiki page created by Mark Hatle that provides good guidelines on how to create well-formed commit messages. (From yocto-docs rev: ea7b0100a7b45c369cb67daa0705dcc5acef40c8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual/dev-manual-newbie.xml: edits and enhancements.Scott Rifenbark
General pass-through for consistency in referencing sections. Also, added Darren Hart's review comments for the "Submitting a Change" section. I added more about the mailing lists and how to submit a proper commit message. (From yocto-docs rev: d9c8f5db8c862b1be724915cc43da6d12b88b97d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual/dev-manual-newbie.xml: new termsScott Rifenbark
I moved the terms "Yocto Project Files" and "Yocto Project Build Tree" into this development manual. They were previous defined in the ADT manual. It makes more sense to have them where with other terms. (From yocto-docs rev: 2133110fd280db8cfbe998e6b46cdee0b260e777) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25documentation/dev-manual/dev-manual-newbie.xml: re-write change submitScott Rifenbark
The section on submitting a change was very sparse and incomplete. I have significantly upgraded this section to provide more details. (From yocto-docs rev: af43bb1e4902c45afb5ac4b0f099877acd7a81a2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-13documentation/dev-manual/dev-manual-newbie.xml: Suggestions Robert BergerScott Rifenbark
I made several edits here. There is some mystery as to which changes are actually part of this commit. I did a 'git diff' and am only seeing one small change. If I later find they are not there I will delete the file and replace with a back up I saved prior to submitting this commit. (From yocto-docs rev: 62c63b3a812eaf92ca2bffa5714a6d327ac32d64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-13documentation/dev-manual/dev-manual-newbie.xml: Updates from Robert BergerScott Rifenbark
Added some clarification on the ability for testing. The wording as it was implied that the YP provided a complete testing framework, which is not true. (From yocto-docs rev: e40b39179c69b69f012f231009131b1efa7e732b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30documentation/dev-manual/dev-manual-newbie.xml: added more to contributingScott Rifenbark
The section on how to contribute changes to the YP resides in this development guide. I took additional information from the YP reference manual and merged it into the section here. (From yocto-docs rev: 945dd29417cf51044332114e499b08fe24ef3077) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23documentation/dev-manual/dev-manual-newbie.xml: Updated term list.Scott Rifenbark
I added a reference to the Image appendix for the description of images. Also, added a new term "meta-toolchain." (From yocto-docs rev: a9c1110ec7499afa669416c00bc81573fcbf920d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23documentation/dev-manual: Incorporated Joshua Lock's review comments.Scott Rifenbark
(From yocto-docs rev: d4bf6343d7575ff96030242e2025570db52b515b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20documentation/dev-manual/dev-manual-newbie.xml: added picture for newbie GitScott Rifenbark
(From yocto-docs rev: 608656076131b7cab829344d8ed0f63c655566d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15documentation/dev-manual: Scott Garman's review comments.Scott Rifenbark
Made several editing corrections for various terms and phrasings based on Scott Garman's review. (From yocto-docs rev: a21ba80151ce82683d45cd67ddb0728d779b007a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15documentation/dev-manual/dev-manual-newbie.xml: fixed git-format-emailScott Rifenbark
Bruce Ashfield review comment indicated incorrect usage of 'git-format-email' command. Changed to 'git format-email' (From yocto-docs rev: 888cc503f836787462dc9d3029c761323037df52) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15documentation/dev-manual/dev-manual-newbie.xml: wording change.Scott Rifenbark
(From yocto-docs rev: 752f43be2f5746d239a937d6b5ca8c5d6d83eac0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15documentation/dev-manual/dev-manual-newbie.xml: Added anchor pointScott Rifenbark
I placed an anchor point in the Index of Downloads bulleted item for reference from other documents. (From yocto-docs rev: 7d4f96d20667fbf5f52e25840b39f1994b1c4cd3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04documentation/dev-manual/dev-manual-newbie.xml: edits suggested by Dave Stewart.Scott Rifenbark
(From yocto-docs rev: c6924422778b525dfe63f5e9a121c92317c3ea25) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04documentation/dev-manual/dev-manual-newbie.xml: updated intro paragraph and figsScott Rifenbark
I updated the introduction paragraph to cast the chapter more for YP than just generic newbie information. Also, added three screenshots for the source areas at Dave Stewart's suggestion. (From yocto-docs rev: 26d3c58ff6295515c593c8b0b12dc3d6952b752a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04documentation/dev-manual/dev-manual-newbie.xml: edits to how to submit ↵Scott Rifenbark
change section. (From yocto-docs rev: 16533369264deb5f93b0d97f0d8491ee45fe23db) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04documentation/dev-manual/dev-manual-newbie.xml: edits to tracking bugs section.Scott Rifenbark
(From yocto-docs rev: 7a4487394f14214c287247020b3abda3c3b6cfde) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>