summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
AgeCommit message (Collapse)Author
2014-06-18dev-manual: Fixed a link that was broke in the mega-manual.Scott Rifenbark
Found a link in the dev-manual that had a hard return splitting the link across two lines. The mega-manual.sed file cannot process those links so it ignores them. (From yocto-docs rev: fabd8d47b4a5ce1e108ad282d9903e3b1daa5f3d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18documentation: Updated manual history tables.Scott Rifenbark
Added a new entry to support the 1.5.3 release. Using July 2014 as the release month and year. (From yocto-docs rev: fcd6046b8b2a5606e77d14cffa0bd2eebbe1748a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-12documentation: Updated the manual revision history tables for 1.5.2Scott Rifenbark
(From yocto-docs rev: c3674816afea52cc37ae842577f8eebf34d20d69) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-17dev-manual: Fixed code block example for ARCHIVER.Scott Rifenbark
There was an incorrect wrapping of code in the source example. Reported-by: Ross Burton <ross.burton@intel.com> (From yocto-docs rev: 5aaa1e2651ec404af1aea5caa4c9f1f63a760e95) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-08poky.ent, documentation: Updated manual release dates.Scott Rifenbark
Updated poky.ent to use 2014 as the top-end copyright year. Updated all the Manual Revision History tables to use January 2014 as the 1.5.1 release date. (From yocto-docs rev: 885a89231c664ccbd9032c45584aa19dce7c0b38) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11dev-manual: Updated the "Working with a PR Service" section.Scott Rifenbark
I added a link to the PRSERV_HOST variable. That variable is now defined in the ref-manual variable glossary. (From yocto-docs rev: ac6050263eba890ea0084f8f8444e967e10004f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: ksize.py and dirsize.py live in scripts/tinyRobert P. J. Day
(From yocto-docs rev: e222eb4b509772c1f5f493a22920e5fe4f5efad6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Add a reference to poky-bleeding distroRobert P. J. Day
As an actual example of using AUTOREV, refer the reader to the Yocto-supplied poky-bleeding distribution. Also cleaned up some wording and added a Caution statement about the distro not being regularly tested - Scott (From yocto-docs rev: 41e9c7d08ecf688c72e7ecac16a6bf030147061d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Documentation: More minor tweaks to dev manual for clarityRobert P. J. Day
i'm still looking at the dev manual for more changes but those would be more substantive changes, so i'll pass along just this collection of minor stuff. (From yocto-docs rev: 3ea3fd4625c571f8cf20e32e6edc03ba1e517e94) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Changed wording of BBMASK exampleScott Rifenbark
I changed the intro text for this one-line example so that it would not imply that the example is the only syntax that can get the job done. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 40cabe53187a94256c8f2c50598610668ea4de77) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Added note about naming your distributionScott Rifenbark
Added a small note in the section where you create your own distribution to be clear about where the name is set. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: f08fef284cb57cfc982b1fd3b4ca1b6fe5b883cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Re-worded menuconfig preparationScott Rifenbark
Rather than saying menuconfig is "built", I changed the text to say it is "run." Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: f95b945787c84edb532c24886cdd44f1bc8bd98a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Re-ordered sections for customizing an image.Scott Rifenbark
The four sub-sections describing how to customize an image seemed to be backwards as they progressed from most complex to easiest. I switched up the order and provided better transitional introductory wording for the four sub-sections. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ebce74fde98fb3d3b74ed476288e482e87c83461) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Number of minor tweaks to Dev Manual, Chapter 5.Robert P. J. Day
(From yocto-docs rev: 779e33c9f1228c54ed1b4e60c109d0b2ecd4b2f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual, ref-manual: Updated some section titles.Scott Rifenbark
I noticed that chapter 10 of the ref-manual still had "Reference: Features" as the title. This is left over from way back. I changed that chapter title to "Features." Next, I noticed an inconsistency with some sub-section titles. I changed the "Images" title into "Image Features." This affected several links across the doc set so I had to update those cross-references as well so they have the latest section title as part of the reference. (From yocto-docs rev: 41de29a5042d92bd34bc52315003a86b6d3277db) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Updated EXTRA_IMAGE_FEATURES operater for read-only-rootfs exampleScott Rifenbark
The operator used was "=" which was inconsistent in light of previous uses of the variable in the ptest section. I changed the operator to "+=" to be consistent. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 2cc73ae4e3a543a60bcc29b54d2de97b08f990db) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Added "Task" term.Scott Rifenbark
After adding "Package Group" definition as the original "Task" definition, we needed to create a new definition for the term "Task". (From yocto-docs rev: bc861fda764a6d5fe0dc3b62b0771e183e7356a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Changed "Tasks" term into "Package Groups" term.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 5e9f2a6192db61ffa93e83a2e5e5d7bcd75e5eb4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: updated the ptest sectionScott Rifenbark
Removed the note indicating that three specific recipes were "ptest-enabled" for the release. I substituted in wording that tells the user to see if a a recipe inherits ptest as a way of determining if the receipe is ptest-enabled. (From yocto-docs rev: f9886957055619e9c5e9eccfe0a606e7aee275cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Re-worded the "Customizing Images Using Custom .bb Files"Scott Rifenbark
Changed the wording so that it reflects better what is actually going on when use IMAGE_INSTALL to afect an image. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 36178822a53f9eb7065513c8b2b1b01fc166b771) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: More minor tweaks to development manual.Robert P. J. Day
(From yocto-docs rev: dc0dd5896e874aa0566bc11c7909c496af130561) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Complete first draft of the new wic section.Scott Rifenbark
(From yocto-docs rev: 4bd0f5db0e0d8a2c3d28f415afaf92fed93102f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: More work on the new wic section.Scott Rifenbark
I am working through the raw text. Not clear through yet but needed to commit this. (From yocto-docs rev: 4da28c311443ad31a0a36b07b39aa7ce4180b49c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Rough draft of wic section.Scott Rifenbark
(From yocto-docs rev: a628ab0034c66f0c62ffd7e9b6010c5afbecee82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Fixed broken structure.Scott Rifenbark
I discovered that the dev-manual was not making correctly. Probably resulted in trying to merge in some of Robert P. J. Day's comments. I have made the tag changes to fix this. Also, I added back in the two methods for setting up meta-intel as I am not making the tarball-exclusion changes to the dora branch. (From yocto-docs rev: a10a9c3960045a777da6245a2502504f15fad579) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Reworded sentence for meta-intel setupScott Rifenbark
Changed wording to remove implications of meta-intel clone importance regarding working with BSPs. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c5f282e2b5f9931103fc4a1adafbf9c5becb0084) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/dev-manual/dev-manual-start.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev manual: Minor tweaks to first part of ch 5, dev-manual.Robert P. J. Day
given the length of chapter 5 in the dev manual, i'm going to do this in bite-size pieces. (From yocto-docs rev: 3db48a0be170a02e5042fe65253c65b5245c6b89) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Some minor tweaks to ch 4, development manual:Robert P. J. Day
* is it technically correct to say there are now 5 BSPs? as in, does genericx86-64 count as a new BSP distinct from genericx86? [aside: are there any plans for a MIPS64 BSP?] - rpjday MIPS64 is under development. - scottrif * if scott is up for it, a couple more variables for the variable glossary might be BASE_WORKDIR and TARGET_VENDOR, which i would have added to that variable list but they don't appear in the glossary - rpjday Noted. - scottrif (From yocto-docs rev: 45876209fd94a6800176381518f008890da646ee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Small number of tweaks to ch 3, development manual.Robert P. J. Day
(From yocto-docs rev: f496e2fb8050830a2daf9f712a9b9b40b4025f1f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/dev-manual/dev-manual-newbie.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: A few tweaks to Ch2 of dev-manualRobert P. J. Day
scott (or anyone else) is welcome to use any or all of this, or tweak to taste. i have a few other concerns with ch 2 but i'll read it more carefully to make sure i'm reading it correctly. - rpjday I implemented all but the addition of MIPS64 as it is not tested using the autobuilder yet. - scottrif (From yocto-docs rev: 9ae733456e1d39de66ad6235172f26cab4a33269) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/dev-manual/dev-manual-start.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Updated Build Directory termScott Rifenbark
The examples went stale. Two out of three did not work. I have provided new examples that work. Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ae50d3ee3c244b2c864d80adf69a7a69fb6e3985) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03documentation: Scrubbed use of directory namesScott Rifenbark
There was inconsistent use of the way directory names were handled throughout the YP documentation. I have scrubbed the set and replaced many instances such as the following: meta/<something> replaces /meta/<something> poky replaces ~/poky (except in some very specific examples) I basically got rid of leading slash characters. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 12a96db6dffe09fca7ce848e006c591a637be5a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: Added a link for the FEED_DEPLOYDIR_BASE_URI variableScott Rifenbark
Fixes [YOCTO #5408] Added a cross-reference link for this variable into the glossary. (From yocto-docs rev: 9e978095d8ef5de514698a7b1959c0612496b56d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03dev-manual: package add using facilities in oe-core only.Trevor Woerner
Fixes [YOCTO #5408] The developer's manual should only refer to functionality which is available in oe-core. Currently, this passage requires the user to add a package from, and use facilities of, meta-oe. This fix describes how to use facilities in oe-core to the same end. (From yocto-docs rev: 0f6d955c5d7fba7258441ce6dbdecfac67d722f7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updated the note about BB Commander/Eclipse WS locationsScott Rifenbark
Fixes [YOCTO #5203] This was reviewed by Alex and an ordering change was needed due to the order of how things are created during the workflow. (From yocto-docs rev: cd55870ac91f5a3e9329dd89bcb175b67bb4aca3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updates to Toaster sectionScott Rifenbark
Partial fix for [YOCTO #4414] I put in the API stuff as well as made sure the other comments for the dora-toaster branch and temporariness of the GUI were mentioned. Probably more tweaks before this section settles out. (From yocto-docs rev: 54dd0edff55c26fb52941e69b1919e30d7a7ec55) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Edits to the toaster sectionScott Rifenbark
Partial fix for [YOCTO #4414] Got some feedback on the section and added a step that the user needs to checkout the dora-toaster branch after clonine poky. Also, that the Django version is specific and not the listed version +. Finally, a bit of wording to note that the GUI is temporary for this release. (From yocto-docs rev: 7d7c42894b05c86366e8b35ec2f8f9e0e7ee5baa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Fixed grammar error.Scott Rifenbark
(From yocto-docs rev: b3efa5dd7c647025da4066c8d44f55a7861ab675) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updated the layer.conf exampleScott Rifenbark
The meta-yocto-bsp/conf/layer.conf example had gone stale. I updated it. (From yocto-docs rev: d77ea0f078675b227a018a57574f5512629c8afb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01adt-manual, dev-manual: Removed the LatencyTop website link.Scott Rifenbark
This site has disappeared and I don't think there is a replacement. (From yocto-docs rev: c568a4f3a66a3cde7f71f9c31ce39814f05b8f38) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updates to Toaster section about examing dataScott Rifenbark
Fixes [YOCTO #4414] Removed the details from the examining data section as directed by Belen. This detail remains in the 1.6 leg but not in the dora branch. (From yocto-docs rev: 2403f20edcfe258c10fd36de891c2f479e0a2d17) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updates to toaster sectionScott Rifenbark
Fixes [YOCTO #4414] Some changes to the toaster section according to the updated toaster wike site and Belen. (From yocto-docs rev: e8ca4c6f14c07e486a0a6a79ec4f98244390e621) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01documentation: Changed Note for most recent manualScott Rifenbark
Fixes [YOCTO #5368] Changes partially address this issue, which is the removal of tarball installations for poky. The notes at the beginning of the YP manuals suggested that the tarball version of a manual might lag the version found on the website. Because we are discouraging installing poky/documentation from a tarball now, I have re-written the note to be generic and suggest simply that for the most recent version of the manual associated with the release, see the manual on the website. (From yocto-docs rev: d47ff8285a6ba01d721509724641a51aab8da73d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Added -ptest to list of complementarty packagesScott Rifenbark
Added the '-ptest' complementary package to the list of packages, which included '-dev' and '-dbg' when using inherit packagegroup. Robert P. J. Day pointed out the code in the OE packagegroup.bbclass class that showed these three packages all together. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 92bbbbe77b5694eb9e11789c6c425be8c47399c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Uncommented the Toaster GUI section.Scott Rifenbark
Removed the comments for the section that describes how the Toaster works with a GUI. I also commented out the smaller section that was used in place of the GUI section before it was fully functional. (From yocto-docs rev: 187e5fe9236742167903cbc7ae11f184256e8712) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01poky.ent, documentation: Updates for building 1.5.1 release.Scott Rifenbark
Changed variables in poky.ent to support building 1.5.1. Added Manual revision entry to all manuals with that table for the 1.5.1 release. (From yocto-docs rev: a1c3196199437c3a7cfdf86e4f78b806c66b6385) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Added note for BB Commander project location.Scott Rifenbark
Fixes [YOCTO #5203] Adding a BB Commander project location that is the same as your Eclipse workspace causes an error. I have added a note warning the user to not do this. (From yocto-docs rev: eff9eeba71cc7f464302b824a07bdb2591149f84) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updates to section on using script to create general layerScott Rifenbark
I made some minor edits to this section for better wording. (From yocto-docs rev: 080a194f4911b97bedcef259ed8a5ab9dc0f9b0a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updated "Using .bbappend Files" section.Scott Rifenbark
The actual file listings for the formfactor_0.0.bb and formfactor_0.0.bbappend files had changed. I updated the listings to match the actual files with the release. (From yocto-docs rev: 8b2e285d83a9bfd97ed123085d046eaeec2be6f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01dev-manual: Updates to "Best Practices to Follow When Creating Layers"Scott Rifenbark
I applied some capital letters to a bullet item for consistency. (From yocto-docs rev: c6bc04dc236ed2afaea888046091015165ab3a85) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>