summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Misc edits to the model chapter (Chapter 4).Scott Rifenbark2014-08-121-15/+33
| | | | | | | | | | | | | | I replaced user-supplied variables with <replaceable></replaceable> tags to get proper formatting. I inserted several references to the new QEMU chapter for help using QEMU. I updated a note on the BSP available so that it is a bit more generic and not so dependent on an exact list within meta-intel and the source repositories. (From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Various small edits to Chapter 3.Scott Rifenbark2014-08-121-7/+7
| | | | | | | | | | Replaced angled bracket items for user-supplied variables with the <replaceable></replaceable> tags. (From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae) 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 downloads picture.Scott Rifenbark2014-08-121-0/+0
| | | | | | | (From yocto-docs rev: 67c71f5a51749e4f15987ce7cb3ae8f22436bb93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Misc edits to Chapter 2.Scott Rifenbark2014-08-121-3/+8
| | | | | | | | | Added some links and fixed up some replaceable items. (From yocto-docs rev: 5c9ce934f13c68c2efbd952f399a8b88e87eb761) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added Toaster to the list of other resources.Scott Rifenbark2014-08-121-0/+6
| | | | | | | (From yocto-docs rev: 14652c5aeb7ae54d079f6360c1fa650638f280ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated section on launching remote GDB.Scott Rifenbark2014-08-121-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #6620] I altered the path name of the .gdbinit file in the text to prepend ~/ to it to reinforce what file the user must modify. I also removed the /home/jzhang string in favor of ~ to make it more general. (From yocto-docs rev: ff09d3a5666c97598adf385f63dee4b30b0f1792) 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 section to add binaries to an image.Scott Rifenbark2014-08-121-1/+5
| | | | | | | | | Review edits from Paul. (From yocto-docs rev: 088410d607418531d6ab8a40fdc9d77495b132c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits to how to find checksum values.Scott Rifenbark2014-08-121-16/+17
| | | | | | | | | Edits from Paul to better word this section. (From yocto-docs rev: 51425ab506050ee5ba30d5c3c10639d5a1b8cc8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor edits via patch to "common tasks" chapter.Robert P. J. Day2014-08-121-10/+14
| | | | | | | (From yocto-docs rev: b1516fb6e6d40e7668ca5a4d5804d1a09c7ed6f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Technical and text edits applied as patch.Robert P. J. Day2014-08-121-25/+33
| | | | | | | (From yocto-docs rev: 703cbe5c037334b3fbf08123b7cc501d36e1e8f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to several examples and some typos.Robert P. J. Day2014-08-121-32/+36
| | | | | | | | | | These catches are from Robert P. J. Day and applied as a patch. (From yocto-docs rev: b805795e9bf68286aa5b79a94792e2fefd293b92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manaul: Small edits to various examples.Robert P. J. Day2014-08-121-4/+11
| | | | | | | (From yocto-docs rev: 6ef54d31664b097b8ceeb5da1b8c48cdc6f673a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates for checksums and wicScott Rifenbark2014-08-021-18/+29
| | | | | | | | | | | | | | | Accidentally put in a couple different things in this one commit. Oh well. 1. New wording for how the user needs to figure out some checksums for a recipe. 2. Fixed up some note placement in the wic reference section. (From yocto-docs rev: 6c13f49c265c99ddd6dcd4ec3c3c8e66b78824e0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor fixes.Robert P. J. Day2014-08-021-4/+5
| | | | | | | (From yocto-docs rev: 71c9e378c86d03e5fb7f4e459e677ad8a9965f52) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated manual overview to include new QEMU chapterScott Rifenbark2014-08-021-0/+5
| | | | | | | | | | | | Fixes [YOCTO #641] Added a new bullet to the list that overviews what the manual covers. (From yocto-docs rev: 54bdb50df3951346a2e926700681db55bd59a2e1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to the wic reference section.Scott Rifenbark2014-08-021-15/+14
| | | | | | | | | | | Pulled a note about future support of commands and options from the bootloader section and got it up in the higher level intro section for that part of the manual. (From yocto-docs rev: f8d677301abcd0d549ea9ad4cca79f43cb2db7f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Miscellaneous fixes in the newbie chapter.Robert P. J. Day2014-08-021-21/+21
| | | | | | | (From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Created new chapter on QEMU.Scott Rifenbark2014-08-022-21/+313
| | | | | | | | | | | Fixes [YOCTO #641] New chapter added that covers the YP instance of QEMU. (From yocto-docs rev: 7ca17d02364af7e5924e23df6c138ab4dd2203d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added support for new QEMU chapter.Scott Rifenbark2014-08-021-0/+129
| | | | | | | (From yocto-docs rev: d8a852e244f1c0f4d5ef33f50844bb1cb479cb92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Modified how to find checksums in the recipesScott Rifenbark2014-08-021-1/+6
| | | | | | | | | | | | | | | | | The section on wrting a new recipe suggested using a "build-fail" method to get bitbake to return exact checksums for code. It was pointed out that this could be a middle-security risk and that we should not do that but instead get the signatures from the upstream website. However, many times those sites don't provide that information. I re-worded the text to note the ideal method (upstream checksums) and then resorted to the "build-fail" method as a "way" to also get them when the upstream location does not have them. (From yocto-docs rev: b06699de2f512b01600bf952a8ee928c2a4c358a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Applied review edits to the 'wic' section.Scott Rifenbark2014-08-021-8/+9
| | | | | | | | | | I made some small edits to the section based on Tom Zanussi's review. (From yocto-docs rev: 560ea7b0eb131e59b190a34cadbe77729e76d61c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed up the list of other references.Scott Rifenbark2014-08-021-32/+51
| | | | | | | | | | | | There was a bogus link in there to the Build Appliance page. I also noted many links that use the <ulink> tag that crossed multiple lines. That is not good. I cleaned all that up. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: a39cea47cae29d7efb8e12495e8eefb484d464c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced "--" with &dash;&dash; throughout.Scott Rifenbark2014-08-021-51/+51
| | | | | | | (From yocto-docs rev: 79fb4973909ff3a2ba5da8cad8c3d7bdb4206003) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Miscellaneous wic edits.Tom Zanussi2014-08-021-35/+44
| | | | | | | | | | This is a set of fixes for miscellaneous dev-manual updates noticed while transcribing wic help for the dev manual. (From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Miscellaneous updates from the wic help text.Tom Zanussi2014-08-021-57/+95
| | | | | | | (From yocto-docs rev: 99b04623aa47d07970f91e2bdf648f25ab54c59b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added --fsoptions to wicTom Zanussi2014-08-021-0/+10
| | | | | | | | | --fsoptions support was recently added to wic, so document it. (From yocto-docs rev: 91efb698eea438083474c1e905dbaad3fffdbd81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: squashfs support added to wic section.Tom Zanussi2014-08-021-0/+2
| | | | | | | | | squashfs support was recently added to wic, so document it. (From yocto-docs rev: 22ca1141953b4fae92e15126da296d3d95e80c25) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Created new "Plugins" section in the wic section.Tom Zanussi2014-08-021-0/+153
| | | | | | | | | | Add a new section discussing plugins, taken directly from the corresponding wic help section. (From yocto-docs rev: c1b4c378a496413f2dde8ad2f043a537cba24b6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to the creating partitioned images section.Scott Rifenbark2014-08-021-0/+91
| | | | | | | | | | | | Fixes [YOCTO #6511] Added a new example to this section that shows how to package up binaries so that you can add them to an image. (From yocto-docs rev: e52acc444c8f142d0469d7274fb936b5242306ec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added note and fixed a grammar spot.Robert P. J. Day2014-08-021-1/+5
| | | | | | | (From yocto-docs rev: 934dbe2faff2a553bf281d55edcd6b8de9c31c06) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Patch to fix some links and references.Robert P. J. Day2014-08-021-3/+6
| | | | | | | | | Add in a few links to member orgs, and update the BitBake link. (From yocto-docs rev: 481c89e9b8e219358db8bfdfff0b5b0150247c07) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated example "foo" recipe name used in examples.Scott Rifenbark2014-08-022-2/+2
| | | | | | | | | | The recipe should be named "foo_1.3.0.bb" instead of "foo_1.3.0-r0.bb". (From yocto-docs rev: c34c3ea05d550fc85ab04036856704a7c04fd64c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added the section on "Creating Partitioned Images"Scott Rifenbark2014-07-231-0/+726
| | | | | | | | | | | This is the section on 'wic'. I have dropped in the same exact section from the 1.5.3 (dora branch) release as a starting point for Tom Zanussi to scrub and update for the master branch. (From yocto-docs rev: e189992bff4249664ba959b1c440541e0b84e03d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed not to the PTEST_ENABLED variable.Scott Rifenbark2014-07-211-10/+0
| | | | | | | | | The note did not need to be there. (From yocto-docs rev: 5ff94a1a412447c1ed1cda64e985b52545ccd9e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Updates to support PTEST_ENABLED.Scott Rifenbark2014-07-031-0/+10
| | | | | | | | | | | | | | | In the ref-manual, I added a new variable description for the PTEST_ENABLED variable. In the dev-manual, I added a note to the "Adding ptest to Your Build" section to mention that the OpenEmbedded system uses PTEST_ENABLED to enable or disable building ptests and that the user does not set this variable directly. (From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed a couple typos in the Template section.Scott Rifenbark2014-07-031-2/+2
| | | | | | | (From yocto-docs rev: 9285eee037022ed29a0bdc2c9ecc628c63b47e2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added permalink display styles to CSS files.Scott Rifenbark2014-07-031-0/+7
| | | | | | | | | | | | | Fixes [YOCTO #5772] Updated each manual's CSS style sheet to contain a style for how the permalink symbol looks on its own and how it looks when a user hovers over it with the mouse. (From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed a mult-line <ulink> cross-referenceScott Rifenbark2014-07-031-2/+1
| | | | | | | | | | | These types of references cannot span multiple lines. If they do then mega-manual.sed will not process the link in the mega-manual.html file. (From yocto-docs rev: 8a06542c0f1fee503eda12052adddaaf9c94ca91) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, yocto-project-qs: New section on working with source files.Scott Rifenbark2014-06-181-0/+97
| | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #5566] For the dev-manual, I created a new section called "Working with Source Files." In the section, I cover how to set up mirrors and also how to pre-fetch source using the bitbake -c fetchall <target> command. For the yocto-project-qs, I removed the mirror information in the "Super User" section, which became redundant with the new section now in the dev-manual. I also, removed the fetchall variation of the bitbake command. Both areas reference into the new section of the dev-manual now. (From yocto-docs rev: f314061e3e752d35ea85ed16a60f7f9292180921) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Creating a Custom Template Configuration Directory"Scott Rifenbark2014-06-181-3/+3
| | | | | | | | | | | | Fixes [YOCTO #5895] Some minor edits to the section. I found a grammar error and a mis-wording. (From yocto-docs rev: 86e85512279a1379d9b30825d6af3e508faa320a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff.Scott Rifenbark2014-06-182-10/+29
| | | | | | | | | | I scrubbed the manual set for appropriate places to reference into the do_clean* type tasks. Found and added several occurrences. (From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated style sheets to remove unused .PNG files.Scott Rifenbark2014-06-181-19/+17
| | | | | | | | | | | | | Fixes [YOCTO #6430] The style sheets were carrying over old .PNG files that are not part of the manuals. I have removed the statements that were using them. (From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Small edit to locating the race failure.Scott Rifenbark2014-06-181-3/+1
| | | | | | | | | | Failure occurs during make, not do_compile as I previously noted. (From yocto-docs rev: 467ea8aa43fac14e3092a30ae15d1ace7a6558ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Second draft of make race section.Scott Rifenbark2014-06-181-10/+45
| | | | | | | | | | | | Fixes [YOCTO #6390] Edits to the "Debugging Parallel Make Races" section. Changes originating from trying the procedure. (From yocto-docs rev: 537f5bd8918450e30ea87465025f0069232cb229) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: First draft of new section on debugging race conditions.Scott Rifenbark2014-06-181-0/+241
| | | | | | | | | | | | Fixes [YOCTO #6390] This is a section on parallel make race situations. The draft is the first cut at the section. (From yocto-docs rev: c225d7fe121270a6f82b9fbffa78c7e3914b113d) 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-182-33/+58
| | | | | | | | | | | | 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>
* dev-manual: Added XSL templates to support permalinks.Scott Rifenbark2014-06-181-1/+10
| | | | | | | | | Fixes [YOCTO #5772] (From yocto-docs rev: 54f7fab50c8ddf9b4ee233610b8fab5b9776e419) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edit to "Package Archtiture" section.Scott Rifenbark2014-06-181-2/+5
| | | | | | | | | | Added a bit more to the ending of the sentence to qualify its meaning. (From yocto-docs rev: 40b309a43d948d5800cfe908e72f6202c095a166) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Writing a New Recipe"Scott Rifenbark2014-06-181-59/+127
| | | | | | | | | | | Received and implemented some feedback from Paul Eggleton on this section. These were unsolicited observations. Reported-by: Paul Eggleton <paul.eggleton@intel.com> (From yocto-docs rev: 48ecc543d9f614b5258ab2573f0406aa3c778647) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Creating a Custom Template Configuration Directory"Scott Rifenbark2014-06-181-113/+111
| | | | | | | | | | | Fixes [YOCTO #5895] I applied some review comments from Paul to tighten up this section. (From yocto-docs rev: 9f17ad00e9e707fcd6f2419762b4281d64f4ed0f) 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-27 10:16:09 +0000