summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual, ref-manual: Removed meta-hob layer from docs.Scott Rifenbark2014-04-011-1/+1
| | | | | | | | | | Hob no longer uses this layer so I removed the two instances in the YP set where it appeared. (From yocto-docs rev: 37e3f261bd61a96a2929a525f9896c39658d26f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: WIP for YOCTO #5554.Scott Rifenbark2014-03-301-60/+111
| | | | | | | (From yocto-docs rev: 00ecee108d87b5c1044e7b6df702e59f0332035f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added error reporting tool informationScott Rifenbark2014-03-301-0/+67
| | | | | | | | | | | | | | | | Fixes [YOCTO #1562] In the dev-manual, I created a new section called "Using the Error Reporting Tool" that describes how to use this feature. The text was based on information I received from Andreea Proca. In the ref-manual, I added a new variable entry for ERR_REPORT_DIR in the glossary and a new report-error class in the class chapter. (From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Noting TMPDIR cannot be on NFSScott Rifenbark2014-03-301-4/+20
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #5442] Updated the TMPDIR variable to call out the scenario where a user might want to separtely set TMPDIR to a local drive and thus be able to have the Build Directory on NFS. Updated the "Build Directory" term with a note indicating that by default, TMPDIR is inside the Build Directory and thus cannot be on NFS. However, the user is able to by-pass that per setting TMPDIR separately outside of the Build Directory. (From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Point out "xterm" needed for eclipse use.Scott Rifenbark2014-03-301-3/+7
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #5766] In the ref-manual, I added "Eclipse" use in the title for the "Graphics Support" packages because the "xterm" package is required for graphics support across all distributions. In the dev-manual, I specifically called out the need for "xterm" as a host package at the top of the section describing workflow with Eclipse. I also updated the cross-reference links to the host package and Linux distro requirements to point into the ref-manual, which is more comprehensive, than into the QS. (From yocto-docs rev: d3405be506fcb113f01d4fcba4631db80a1ed5dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added notes saying you need to work from same branchesScott Rifenbark2014-03-252-14/+48
| | | | | | | | | | | | Fixes [YOCTO #4601] Added a couple notes saying that you need to be in matching branches for meta-intel and poky. (From yocto-docs rev: 02bd63829b1d98f21183a10707753e9767bfe68e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added more detail for using an external SCM.Scott Rifenbark2014-03-251-5/+21
| | | | | | | | | | | Provided more information based on an IRC conversation that Richard Purdies saw on #yocto. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: ec28d9f8f01a6e58ade2954e4e6f2ff1c11aa198) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Changed core-image-basic to core-image-full-cmdlineScott Rifenbark2014-03-252-9/+13
| | | | | | | | | | | | | | | Fixes [YOCTO #2424] Some imgage names were cleaned up to have more meaningful names. These doc changes here take care of changing "core-image-basic" to "core-image-full-cmdline". Five instances changed. (From yocto-docs rev: b758f9645e66867b5728da1dd989bae70a216fcc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added new summary parameter to do_split_packages list.Scott Rifenbark2014-03-251-0/+3
| | | | | | | | | | | | | | Fixes [YOCTO #5406] In the "Making Sure the Packaging is Done" section, I added the Summary parameter the laundry list of parameters for the do_split_packages list in the section. Paul Eggleton reviewed the change and approved it. (From yocto-docs rev: 4c4f60ee611921d9f0f835a081b449565382ab90) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Maintaining Open Source License..."Scott Rifenbark2014-03-251-5/+6
| | | | | | | | | A few minor edits. (From yocto-docs rev: 6051ad964bda3ba78ea3a75199fda87133cc08fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Profiling with OProfile"Scott Rifenbark2014-03-251-11/+11
| | | | | | | | | Minor edits. (From yocto-docs rev: 551127f3afa65f36bf9baf21d0ca3e53a2fbb3c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Examining Builds Using the Toaster API"Scott Rifenbark2014-03-251-5/+9
| | | | | | | | | Minor edits. Needed to add a few cross-reference links. (From yocto-docs rev: 47d7c408984a552a6c5d25ac880b50634c576cc5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Debugging with the GNU..." section.Scott Rifenbark2014-03-251-3/+3
| | | | | | | | | Minor edits here. (From yocto-docs rev: f2d8dfa11af30699f912853814e3dce37b335d34) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Performing Automated Runtime Testing"Scott Rifenbark2014-03-251-18/+18
| | | | | | | | | Minor edits. (From yocto-docs rev: 29b999f259bc9c87ad0b2e3c1d54f5473b66edbc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Creating a Read-Only Root Filesystem"Scott Rifenbark2014-03-251-4/+4
| | | | | | | | | | | I changed the way I referenced the read-only-rootfs feature. Since it is something on the right side of a variable equation, I decided to not render it in a Courier font. I have quoted it. (From yocto-docs rev: 90804e71e43cddd3ac7c194a677acaab0c866ed6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Using an External SCM"Scott Rifenbark2014-03-251-7/+10
| | | | | | | (From yocto-docs rev: 37a53af6448f10e8b8f7104295c4e927480312c5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Selecting an Initialization Manager"Scott Rifenbark2014-03-251-69/+16
| | | | | | | | | | Mainly changed the way I referred to Systemd and SysVinit. I was rendering them in a courier font, which was not correct. (From yocto-docs rev: 179ae65ffdfcf59c36e4a3d315855d50722ad890) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed a reference to the systemd class.Scott Rifenbark2014-03-251-2/+2
| | | | | | | | | | I try not to use <class>.bbclass when referencing a class in text unless specifically noting the .class file itself. (From yocto-docs rev: 92c010a198b5c2e1da2ad979e6ca41cb7cd96e7e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Building Software from an External Source"Scott Rifenbark2014-03-251-3/+3
| | | | | | | | | | Changed a reference to a class to conform to how it is done in the books. (From yocto-docs rev: df925b87e4b4962aca913677d8ea01b60b8f99dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Working With Packages"Scott Rifenbark2014-03-251-19/+28
| | | | | | | | | Mostly minor edits. (From yocto-docs rev: 4076cf666a3161c5b816bdc56ff0a4edca5ada32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits for "Building a Tiny System"Scott Rifenbark2014-03-251-10/+22
| | | | | | | | | | Minor edits. Created some links at the top for organizational purposes. Clarified what the linux yocto Git repositories are. (From yocto-docs rev: adbb8ecb0bce5775153d43bec4b70b2439bc8846) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Creating Your Own Distribution"Scott Rifenbark2014-03-251-7/+8
| | | | | | | | | | | | Eliminated the redundant [required] and [optional] side-notes for some variables. Minor fix to re-word use of "append files". (From yocto-docs rev: 9db7059c9b95871cf876d6d75f8377de943bff85) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added yocto-layer script note and updated kernel versionScott Rifenbark2014-03-251-6/+21
| | | | | | | | | | | | | | | I added a bit about the layer creation in the patching the kernel section. The example does it by hand and now you could obviously use the yocto-layer create script. I made a note of saying the example does it by hand. Also, in the menuconfig example. I updated the kernel version from 3.4 to 3.14. It was very old. (From yocto-docs rev: 2696d4e45bccbb910c3d721e3f1d46d48309ee6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Typo fixed.Scott Rifenbark2014-03-251-1/+1
| | | | | | | (From yocto-docs rev: 89199f983669ff0b6f02314753f2015fd88509ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to two sections - new machine and libsScott Rifenbark2014-03-251-40/+63
| | | | | | | | | | | | | Edits to "Adding a New Machine" and "Working With Libraries". Minor corrections. I did do a significant rewrite of the first two sections of the "Adding a New Machine" section as it was very poor. (From yocto-docs rev: 0a030e44f0f1bf2bb204f24b63b4ddfc0cde8252) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-thru edits to "Writing a New Recipe"Scott Rifenbark2014-03-251-19/+19
| | | | | | | | | Minor edits. (From yocto-docs rev: 8e0de3f767af4b2ca182d9f321bd3c8286773913) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-through edits to "Customizing Images".Scott Rifenbark2014-03-251-4/+5
| | | | | | | | | Minor items fixed. (From yocto-docs rev: a57772d157a3340d6ae707990d6076e344e15c75) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-through edits to "Understanding and Creating Layers".Scott Rifenbark2014-03-251-29/+38
| | | | | | | | | Some minor edits applied. (From yocto-docs rev: 1897997ad3ef3ada76de77c7fb886fb624dcdfdb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-through edits applied to "Models" chapter.Scott Rifenbark2014-03-251-19/+22
| | | | | | | | | | | | | | Several items taken care of here. Of note are the retiring of three BSPs (Chief River, N450, and sys9* stuff). Also of note is that Kepler recommended version is now 4.3.2 and not 4.3. The interface changed a bit as well in the section for installing that stuff. (From yocto-docs rev: 61bf82c1e68156d32a81e4c76dbb29db14665ffb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: WIP - Some edits to Chapter 4 from the read-through.Scott Rifenbark2014-03-251-13/+20
| | | | | | | (From yocto-docs rev: 8c38d549b490aa847e7a9ebefe93ddeb79dbc5f9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added Haswell BSP to list of BSPs in meta-intel.Scott Rifenbark2014-03-251-1/+2
| | | | | | | (From yocto-docs rev: 0a5a05030b7b1bb309f90d55f58de91dd008813f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Read-through edits to Chapter 3.Scott Rifenbark2014-03-251-104/+159
| | | | | | | | | | The changes are a result of a detailed read-through prior to releasing YP 1.6. The changes are varied and random. (From yocto-docs rev: 04c09abf96a04c3ffeea8cdf7be8e1bb1b9055c6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, mega-manual: Updated the Git Workflow figure.Scott Rifenbark2014-03-251-0/+0
| | | | | | | | | | | The figure had a wrong box label in the right-bottom box. I changed it to be like a local Git repository area as it should be. (From yocto-docs rev: 2963152decb2d3983180a0af9896e822c865f5cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: General edits to the getting started chapter.Scott Rifenbark2014-03-251-26/+33
| | | | | | | | | | Did a read-through of this chapter in preparation for the YP 1.6 release. Found several little areas that needed attention. (From yocto-docs rev: 73d56a4c948c675afd4cde0e3321a944a02013cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, yocto-project-qs: Recommending 50Gbytes of free space now.Scott Rifenbark2014-03-251-1/+1
| | | | | | | (From yocto-docs rev: 08581479fe38105afd2879742ac9531ef76e1eaa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added a cross-reference link to BitBake term.Scott Rifenbark2014-03-251-1/+1
| | | | | | | (From yocto-docs rev: aab031fcb44b92bdfc1a240e095dc634e0aa0cde) 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 the build system.Scott Rifenbark2014-03-252-2/+5
| | | | | | | | | | Had to add a cross-reference anchor tag to the term in Chapter 3 and then the link itself. (From yocto-docs rev: 227c8ce85f4a8e81f14582cdc7c54b5b832d3aa0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor edits to the "Introduction" chapter.Scott Rifenbark2014-03-251-9/+6
| | | | | | | | | | | I fixed a few things as part of the read through prior to the 1.6 release. In particular, I added the link for the BitBake User Manual, which is now published alongside the YP manuals. (From yocto-docs rev: af779a5a70790d9c15584e1a463e1f0a5c79987f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed "Relased date" for the 1.5.1 entryScott Rifenbark2014-03-251-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #5857] I had missed replacing the release date in the manual revision history tables for the 1.5.1 release. It was still an estimate. I have replaced with the actual date of "January 2014" (From yocto-docs rev: fb9abe0df33a9b551d797ac1b72577931f5f8ce6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added note about Project names in Eclipse.Scott Rifenbark2014-03-251-0/+5
| | | | | | | | | | | | | Fixes [YOCTO #5814] I placed a brief note in the section where it talks about adding a project to an Eclipse project that states you can't use special characters in the project name. (From yocto-docs rev: a03b5849394a6ca3a787b444d95fa49b9db36dd5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed code block example for ARCHIVER.Scott Rifenbark2014-02-171-2/+1
| | | | | | | | | | | There was an incorrect wrapping of code in the source example. Reported-by: Ross Burton <ross.burton@intel.com> (From yocto-docs rev: 478c3bba9e4b1b72dd11b58ebf9eb7ed54e80081) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the section that describes finding source code.Scott Rifenbark2014-01-211-43/+31
| | | | | | | | | | I changed the description to match that which is used in the WORKDIR variable. (From yocto-docs rev: 7d9071c2bb99e7c3f3eeae9ddf0abc34563c6725) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Another small fix to the EXTENDPE definition.Scott Rifenbark2014-01-211-2/+2
| | | | | | | | | | Better wording as it is described in the "Writing a New Recipe" section. (From yocto-docs rev: 88b039ccd0aa825220de091ea7225ada3d212553) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Small fix to EXTENDPE definition in "Writing a New Recipe"Scott Rifenbark2014-01-211-3/+4
| | | | | | | (From yocto-docs rev: 1d020cd87e5b843622422db79f09b564da526376) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits to "Writing a New Recipe" section.Scott Rifenbark2014-01-211-8/+15
| | | | | | | | | | Final review comments from Paul Eggleton implemented here. This should be it for the new section. (From yocto-docs rev: 5307b471c73f46103e0a031172df3174c1880806) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added review comments to "Writing a New Recipe" section.Scott Rifenbark2014-01-211-8/+19
| | | | | | | | | These changes are Paul Eggleton's fourth review change. (From yocto-docs rev: 8470c1b516f7799148b4e2eae28534730e93b58b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual, dev-manual: Updated the recipe flow figure.Scott Rifenbark2014-01-211-0/+0
| | | | | | | (From yocto-docs rev: 746eacaf4256c2b28182ca69f4d393025f854a68) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor re-wording to introduce recipe flow diagram.Scott Rifenbark2014-01-211-1/+1
| | | | | | | (From yocto-docs rev: e8f169a3547cff5da0e4811f706f2cef5eb3be4d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to the "Writing a New Recipe" section.Scott Rifenbark2014-01-211-37/+38
| | | | | | | | | | Completed applying the revision comments from Paul Eggleton for the third revision of this new section. (From yocto-docs rev: d641aa6318cb87e9d41dda39cc4747c44888aa4d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to the "Writing a New Recipe" section.Scott Rifenbark2014-01-211-117/+89
| | | | | | | | | Implemented some third review feedback from Paul Eggleton. (From yocto-docs rev: 3fd9c3cc4cf2aba876f0ad2ab36660ec32ea4c08) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>