summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/usingpoky.xml
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: scrubbed eglibcScott Rifenbark2015-02-171-54/+75
| | | | | | | | | | | | Removed the references to eglibc and replaced them with glibc. This involved updating the example buildhistory output with current examples as well Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b44cce9817191d616d51d6b1d067efc730423198) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated text for speeding up builds.Scott Rifenbark2015-02-171-4/+5
| | | | | | | | | | | | | | | | | | The "Speeding Up the Build" section presents a list of items the user can consider when they want to tweak the build speed. One of the items is the three variables BB_NUMBER_THREADS, BB_NUMBER_PARSE_THREADS, and PARALLEL_MAKE. It was noted that the system figures out the optimal settings for these now and it is pretty useless to override the settings. However, the introducing sentence to the list is still valid due to other considerations that go beyond these three variables. So, to update the text, I have re-emphasized the role of these three variables for quickening the build time. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 84610550cef66d0aa7478bcf95ad97b081709b2f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: WIP - Edits for the speed section.Scott Rifenbark2014-12-091-139/+142
| | | | | | | (From yocto-docs rev: 3a158dbefe32fb1e87718558462c0562077052c8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: WIP - New section on speeding up builds.Scott Rifenbark2014-12-091-0/+139
| | | | | | | | | Fixes [YOCTO #5594] (From yocto-docs rev: e841f3c59f0c272f8a7314b2de20bab6581149cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-13/+13
| | | | | | | | | | | | | | | Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Applied migration review edits.Scott Rifenbark2014-10-181-1/+1
| | | | | | | | | | Applied the full set of first draft revision edits for the new migration section for 1.7. Comments from Paul Eggleton. (From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the build history section for build-id.txtScott Rifenbark2014-10-181-2/+4
| | | | | | | | | | | This file is what is written now rather than build-id. I changed the file name and noted that it also contains the full build header information as written out by BitBake during the build. (From yocto-docs rev: 7e55b4b5f9e27f6ac5d8f1eab4923bf1b8a712c6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Replace a couple old references to "task-*"Robert P. J. Day2014-07-231-1/+1
| | | | | | | | | Replaced with packagegroup names, the newer form. (From yocto-docs rev: 5492b0669acc9ce8a8ee1a00dfdc7e9f2b98a5c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: renamed "do_package_write" to "do_package_write_*"Scott Rifenbark2014-07-211-1/+1
| | | | | | | | | | I found an occurrence where we were refering to the removed task do_package_write. I changed it to "do_package_write_*" (From yocto-docs rev: 4e989f2df1cf74c81ba9d02088addb79012762a7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Modified licensing verbiage for GPLv3Scott Rifenbark2014-07-211-2/+3
| | | | | | | | | | | | Fixes [YOCTO #6499] Updated three areas to include similarly licenced components regarding the use of non-GPLv3 licensing. (From yocto-docs rev: 88c0720e4070be58fbde17bc04db2b53c3307bf8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark2014-06-181-15/+20
| | | | | | | | | | | | There was inconsistency on how we refer to a task name throughout the YP manual set. The proper way is "do_<taskname>". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added links to new do_* sections.Scott Rifenbark2014-05-131-5/+9
| | | | | | | | | | | | | | With the creation of the new chapter that documents the 51 tasks defined by the OpenEmbedded build system, the remainder of the ref-manual had many first-instance occurrences of do_* task names that could be cross-referenced to the new sections. I have added these links. (From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the "Using" chapter.Scott Rifenbark2014-03-301-8/+30
| | | | | | | | | | | | | | | | Along with some minor things I did the following: * Added a brief explanation and reference to the reporting error tool. It seemed like a good chapter to include it. I put it in the debugging section. * I added a pointer to the BitBake manual right at the top of a section that had many usages of the bitbake command. (From yocto-docs rev: 9317433bc715e9fdac2fc629ed659ac926d67531) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to "Running Specific Tasks"Scott Rifenbark2014-03-251-1/+2
| | | | | | | | | | | | Paul Eggleton noted that the output to bitbake <target> -c listtasks was documented as going to a specific file only when in fact it also goes to the console. I updated the section to include that fact. (From yocto-docs rev: 0ed7da3f0fc21412c1045889f241a3d86587d16f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to "Understanding What the Build History Contains" section.Scott Rifenbark2014-03-251-1/+1
| | | | | | | | | | | | | | | The opening sentence here said that the build history is kept in the $TMPDIR/buildhistory directory in the Build Directory as defined by the BUILDHISTORY_DIR variable. Well, the variable claims it is kept in $TOPDIR/buildhistory. I went with the variable as the correct source. So, I changed the intro sentence here. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 242e372affe771776bdfc17f3e3f5187d8965467) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the "Maintaining Build Output Quality" section.Scott Rifenbark2014-03-251-34/+8
| | | | | | | | | | | | | Removed the bit about isolating SDK information. Also removed the workaround and text regarding the limitation that caused adding and removing INHERIT += "buildhistory" to re-execute tasks. Added a few links to some newly documented variables. (From yocto-docs rev: 7d13bea6d9f0c2bdc9aa58c2933998d6d10ac810) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to "Maintaining Build Output Quality"Scott Rifenbark2014-03-251-7/+27
| | | | | | | | | | | I modified a few areas to help integrate some newly documented BUILDHISTORY_* variables. Mostly some rewriting to feature some variables that help the user select build history features. (From yocto-docs rev: 8cb6a09ba7f0bd645a12e6f7a93247a9f0e77980) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed depends.dot filename to pn-depends.dot.Scott Rifenbark2013-12-031-1/+1
| | | | | | | | Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: bd9f4ab6bd54a6d0edff1f5cfb6ea4d46f5bc9f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added the pn-buildlist file to list of filesScott Rifenbark2013-12-031-8/+13
| | | | | | | | | | | | | In the "Dependency Graphs" section, the pn-buildlist file was not mentioned as a file generated by the 'bitbake -g <target>' command. I added this in and provided a bit of re-writing. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 435de6a980bd182e8033319e479ded1414e93eed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Cleaned up some instances of the term "working directory"Scott Rifenbark2013-12-031-4/+5
| | | | | | | | | | | | | This term should always reference a users current working directory and not be confused with the OpenEmbedded build system's "work directory (WORKDIR). I found several instances where the term "working directory" was not used correctly and fixed them. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Scrubbed use of directory namesScott Rifenbark2013-12-031-1/+1
| | | | | | | | | | | | | | | | | 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: ae2e451ed8f61484d04b30017021912c4493a441) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to "Variables" and "Building with No Dependencies"Scott Rifenbark2013-12-031-11/+22
| | | | | | | | | | | | There was some confusion over some things in these two sections. I re-wrote them with the help of Paul Eggleton to be clear on them. Reported-by: Robert P. J. Day (rpjday@crashcourse.ca> (From yocto-docs rev: ab352523e82626d8356d8b2c07fb10d2d60ea254) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Pedonic tweaks to ref manual usingpoky.xmlRobert P. J. Day2013-12-031-5/+5
| | | | | | | | | | Patch from Robert P. J. Day. Good catches for some minor wordings and such. (From yocto-docs rev: 44c98e879bddfee49a5b89e7bb9c94c403284140) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated files in the image part of build historyScott Rifenbark2013-10-081-2/+9
| | | | | | | | | | | | Fixes [YOCTO #5303] Added a bullet item to the files listed as part of images in the buildhistory figure. (From yocto-docs rev: 5c4c581cde509b880b0d36dad399df0cb510b2d2) 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-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | 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, poky.ent: Fixed broken Release Note schemeScott Rifenbark2013-05-311-28/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The URL naming convention for the YP Release Notes has changed. It now takes the following form: http://www.yoctoproject.org/download/yoctoproject-15-poky-1000 The above is an example for YP Release 1.5 and poky release 10.0.0. I have set up three new variables in the poky.ent file to somewhat automate the links in the docs to point to the location of a given set of release notes: 1. DISTRO_COMPRESSED - set to the DISTRO string with no period (e.g 15 for 1.5). 2. POKYVERSION_COMPRESSED - set to the poky version with no periods (e.g. 1000 for 10.0.0). 3. YOCTO_RELEASE_NOTES - set to the full-blown release note URL. I made two changes to existing links for the Release Notes. One was in the dev-manual and one was in the ref-manual. (From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Minor edits suggested by Bill TraynorScott Rifenbark2013-05-221-2/+2
| | | | | | | | | | Applied some re-wordings as suggested by Bill Traynor. Reported-by: William M.A. Traynor <wmat@alphatroop.com> (From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to patch 3 of 5 for build history.Scott Rifenbark2013-04-101-2/+3
| | | | | | | (From yocto-docs rev: 76badd435b858fd37181baabefb39bfa656baf1c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied Paul Eggleton's Build History Patch 3 of 5.Paul Eggleton2013-04-101-0/+8
| | | | | | | | | | Add a paragraph to the top of the section on buildhistory mentioning the metadata-revs file and the top-level directories. (From yocto-docs rev: ae7c7c64dd31f5b5c57eac9c772972523f49c05a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits applied to buildhistory patch 2 of 5.Scott Rifenbark2013-04-101-26/+39
| | | | | | | | | | Did some rewriting to conform to the manual's style and formatting. (From yocto-docs rev: 6a961978b207d8992ade86f82838914b858accdb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied Paul Eggleton's buildhistory patch 2 of 5.Paul Eggleton2013-04-101-0/+52
| | | | | | | | | | | | | | | | Additional information added to the end of the "Build History Package Information" section." Buildhistory now collects information on SRCREV values for recipes fetched from a version control system e.g. Git; additionally a buildhistory-collect-srcrevs tool is provided to gather this and convert it to a format suitable for inclusion in global configuration. Add information on these new features to the appropriate section. (From yocto-docs rev: 8c38bcbe8e737d7dfb41a763c87a3a6269e6f980) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to buildhistory patch 1 of 5.Scott Rifenbark2013-04-101-20/+24
| | | | | | | | | | I did a bit of cleanup on the text from Paul's patch number 1. Just some active voice stuff mainly. (From yocto-docs rev: f08fa3da997e53c587e3f17ef908e41594654db3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: buildhistory patch 1 of 5 applied.Paul Eggleton2013-04-101-0/+62
| | | | | | | | | New section titled "Build History SDK Information" added. (From yocto-docs rev: aaa9ee5690a68f72b21ca3ab731942d80acac2f3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typo.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: ba5854e0d46f33ec13d6c17c121285e5e719d19a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "Enabling and Disabling Build History"Scott Rifenbark2013-04-041-15/+15
| | | | | | | (From yocto-docs rev: 2d23ad6f5f9047d37496f686dd1f9d8265ee7d55) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to "Other Tips" section.Scott Rifenbark2013-04-041-2/+4
| | | | | | | (From yocto-docs rev: 46147dadd1627ba24c2cca27a47872b7390c354f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Punctuation fix in "Logging With Bash" section.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 7b13b4b664802b31233ac3638913091d3a7af45c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor fixes in "Logging With Python" section.Scott Rifenbark2013-04-041-2/+2
| | | | | | | (From yocto-docs rev: 6dac8debd55756b907112f8470e5ea9adececeed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: rewrite of the "Variables" section.Scott Rifenbark2013-04-041-4/+6
| | | | | | | | | | this was really old text and had not been touched since the original poky handbook days. It was terrible. (From yocto-docs rev: 4f3efdbf2920f7d3f2d0d0526d08340c6204856a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Typo fixed.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: bcf125eb34bfafcf828cdcb44f9bdaa9a21e7007) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Small updates to the "Running Specific Tasks" section.Scott Rifenbark2013-04-041-2/+4
| | | | | | | (From yocto-docs rev: e5be2cd9d949fdb5dab1e6965c5970b5a62359fc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the "Debugging Build Failures" section.Scott Rifenbark2013-04-041-0/+8
| | | | | | | | | | Added a couple cross-references for some general debugging information within the manual set. (From yocto-docs rev: d102e90fc9b24aa703eeb4488561058c258600d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed "/" as part of a sentence.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: e578cf8ec7bbd571b6ba5842fe1a24c219916181) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Various edits to the "Build Overview" section.Scott Rifenbark2013-04-041-5/+5
| | | | | | | (From yocto-docs rev: ad017a31cc79b97baaa562d05aa0dab3bf45bd35) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Created "Development Host System Issues" sectionScott Rifenbark2013-02-141-0/+31
| | | | | | | | | | | | | Fixes YOCTO #2790 Created a new section in the "Debugging Build Failures" section to deal with host issues that cause a build to fail. (From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Rename of poky-ref-manual folder to ref-manual.Scott Rifenbark2013-01-071-0/+651
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) 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-11-15 13:23:53 +0000