summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: dev-manual - Final changes before 1.3 lockdown.Scott Rifenbark2012-10-231-16/+16
| | | | | | | | | | Made minor changes as needed due to some new sections, links, and capitalization standards. (From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - fixed capitalization on Source Directory.Scott Rifenbark2012-10-231-14/+14
| | | | | | | (From yocto-docs rev: 8cfbd4eb519b2b966626c9a1ffd8515c198c2abd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updates to Git workflow and kernel patchScott Rifenbark2012-10-231-4/+4
| | | | | | | | | | | I updated the sections on the "Git Workflow" in Chapter 4 and the "Patching the Kernel" section in Chapter 5 per Tom Zanussi's review comments. Minor technical changes. (From yocto-docs rev: fd8a291349c06328adebd37f8a9bbeaa49adb44c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updated compliance section.Scott Rifenbark2012-10-191-10/+11
| | | | | | | | | Applied legal changes per Karen Copenhaver's suggestions. (From yocto-docs rev: 73b68aa349530f6604c7edc87b503f1b614b2c46) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Edits to "Patching the Kernel" section.Scott Rifenbark2012-10-171-31/+24
| | | | | | Edits according to Darren Hart's feedback. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - small edit to compliance section.Scott Rifenbark2012-10-171-1/+1
| | | | | | | (From yocto-docs rev: 4c80b414645b1cb8750dd877a1f857807a9f1259) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - edits to the compliance section.Scott Rifenbark2012-10-171-3/+3
| | | | | | | | | | | | | | | | Feedback from Paul Eggleton suggested to not use the linked term "Source Directory" in the last paragraph of this section. Reasoning being that it is mis-leading in this case. People reading this will be thinking more along the lines of traditional source code rather than our establishe "Source Directory" term, which in the doc set refers to either the unpacked poky tarball or the cloned poky Git repository. Reported-by: Paul Eggleton <paul.eggleton@intel.com> (From yocto-docs rev: f9bfcdebf85481839df01442ee81c4c9e8ee559a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Removed whitespace.Scott Rifenbark2012-10-171-11/+0
| | | | | | | (From yocto-docs rev: 8f6479e8e04a54929e704064ecb44e3fee3cf8b3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - edits to kernel section and complianceScott Rifenbark2012-10-151-158/+166
| | | | | | | | | | | | * Edits to get the patching the kernel section more sane. * A tweak to the opening sentence of the compliance section to rid it of the split-infinitives. (From yocto-docs rev: 8e2ff293e85a602efd98aceb20da5a2ea5f2a34d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - edits to the license compliance section.Scott Rifenbark2012-10-151-16/+33
| | | | | | | | | Implemented Beth Flanagan's review comments. (From yocto-docs rev: d480c8525861db4383ce1b656168c01d01c26b2e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - edits to the patching the kernel and model sections.Scott Rifenbark2012-10-151-25/+47
| | | | | | | | | Made changes to try and clean up the process. (From yocto-docs rev: 9c4fbcb473dc594647ba8779162379a745f8f8d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Added license compliance section.Scott Rifenbark2012-10-151-2/+210
| | | | | | | (From yocto-docs rev: a94b34506152f3494f1acce7b03318d3b5a0a283) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Makefile, dev-manual - edits to patching kernelScott Rifenbark2012-10-151-85/+112
| | | | | | | | | | | Made some general edits to the new "Patching the Kernel" section. Also had to remove a couple of images no longer used in the section from the Makefile "TARFILES" variable. (From yocto-docs rev: ac61e22e2f89926fbbda56fbaa4384c3c5156360) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - edits to patching kernel section plus othersScott Rifenbark2012-10-101-314/+8
| | | | | | | | | | | Removed the temporary text in the new "Patching the Kernel" section that was copied from the old appendix A. Fixed the PRINC variable in the creating a new layer example. (From yocto-docs rev: 3eba77a81d3460866638a2f2d6b7c27d9dd1a2be) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual, bsp-guide, kernel-manual - kernel workflowScott Rifenbark2012-10-101-2/+10
| | | | | | | | | | | | | | The kernel workflow section was re-written to reflect that the kernel appendix has been removed. Also, changes to the flow in general no longer make reference to the bare clone and the copy of the bare clone as a method used to modify the kernel. Many links were modified in other manuals as well. (From yocto-docs rev: 38adbcb00d4305029cfa94e5ef047da41823f021) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual, bsp-guide - Removing/Moving Appendix AScott Rifenbark2012-10-101-0/+559
| | | | | | | | | | | | The kernel example appendix is being removed. This broke a lot of links. For now I have moved the information into a new section called "Patching the Kernel". I have preserved the information by adding the old appendix file as kerne-appendix-orig.xml. (From yocto-docs rev: 994235a69362dfb0114ef9001ea7f2f2e2fdc5c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updates to configuring Kernel sectionScott Rifenbark2012-10-101-7/+81
| | | | | | | | | | | | | Eliminated the section A.2, which had an example of how to use menuconfig in the kerenl example appendix. The information is now merged into the similar section in Chapter 4 "Common Tasks." It was decided that the Appendix A examples in the manual were too detailed for a general development guide. (From yocto-docs rev: f88ec421b257657f02cc0f132ec2580c17f07cef) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: bsp-guide, dev-manual, kernel-manual - Removed linksScott Rifenbark2012-10-101-8/+2
| | | | | | | | | | | | Removing the Appendix A (BSP) example had some rippling affects throughout the doc set. There were several links into the appendix. All these links had to either be modified (if possible) or simply removed since the appendix will be removed. (From yocto-docs rev: fff35abd87e945de1806eef63a56a956d104bf92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updated Enabling Your Layer sectionScott Rifenbark2012-10-101-2/+12
| | | | | | | | | | | | | | | This section was out of date. I copied in the most recent version of the bblayers.conf file, which sets LCONF_VERSION to "6" now. Also, added the meta-yocto-bsp layer to the example. Additionally, I inserted a Note explaining the consequences of removing the meta-yocto layer. The note references [YOCTO_#3176] for more information. (From yocto-docs rev: 532b72c5c18b2a9a61619164bae6216c91c2ecc9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - updated LCONF_VERSION in the example.Scott Rifenbark2012-10-101-1/+1
| | | | | | | | | The current setting was changed from "1" to "6". (From yocto-docs rev: 7f5be4b0b2d1e17add774c7ba3b8803ad770a8fc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Updated bblayers.conf exampleScott Rifenbark2012-10-101-0/+1
| | | | | | | | | | Added the meta-yocto-bsp layer to the example listing in the "Enabling Your Layer" section. (From yocto-docs rev: 95fb13a1049ccaffb3531c93a28a3c480ea1a243) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Wording changes for bumping PRPaul Eggleton2012-10-021-5/+5
| | | | | | | | | | I edited the patch from Paul a bit here to conform to the style of writing plus to make things clearer. (From yocto-docs rev: 87abf857cfcd8a0d78a48322fbe9ac5395b6ad30) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Created list of option.Scott Rifenbark2012-10-021-6/+11
| | | | | | | | | | | | Better display of the SELECTED_OPTIMIZATION variable options when they appear as a list. Also, some punctuation added. (From yocto-docs rev: 73777e545f13eacca9ee466ba852bccd84c17f6f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar fix and SDK caps on.Scott Rifenbark2012-10-021-4/+4
| | | | | | | | | 'sdk', when used in general terms should be capitialized. (From yocto-docs rev: 1d68746ae197620b533a9ad53e71b16c9e4e42b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - caps for SDK when used in general.Scott Rifenbark2012-10-021-1/+1
| | | | | | | (From yocto-docs rev: 59ef0682eeb5137fb617a0b8f3813ceca16f2f83) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - grammar correction.Scott Rifenbark2012-10-021-1/+1
| | | | | | | (From yocto-docs rev: c127a2f1eaf401728b295113b66ca5828619fbea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - added cross-reference to PN.Scott Rifenbark2012-10-021-1/+1
| | | | | | | (From yocto-docs rev: 11c87eb29fb7d87eadbbca698ec37b806f49f790) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - minor wording change.Scott Rifenbark2012-10-021-1/+1
| | | | | | | (From yocto-docs rev: 75c4e2fe0932ba44804925688c4c6a5347d3bb31) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - minor edits and links added to glossary.Scott Rifenbark2012-10-021-7/+14
| | | | | | | (From yocto-docs rev: a5d66dd66458eab2ec4ca54f73ae0a46d44f430c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - minor edits.Scott Rifenbark2012-10-011-2/+3
| | | | | | | (From yocto-docs rev: e138827210fecaecd90998d7e15561c4db083353) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Fixed a term for consistency.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: e4d1b880578e1aaf842e89fe3ce16683cfdebc70) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - more wording changes.Scott Rifenbark2012-10-011-4/+4
| | | | | | | | | | I found other changes for underlying/corresponding wordings regarding the relationship between .bb and .bbappend filenames. (From yocto-docs rev: 28f12a4ea97a683281cd8cc0bbceb40d2b896aa4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - better wording for the .bb fileScott Rifenbark2012-10-011-1/+1
| | | | | | | | | | Better choice of word here is "corresponding" rather than "underlying". (From yocto-docs rev: 3d8b6d6e06b81960df2a7d25b6d54308210cc011) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: deb-manual - updated list of layers in the repoScott Rifenbark2012-10-011-2/+3
| | | | | | | | | | The manual listed an out-dated example listing of meta-* layers in poky. (From yocto-docs rev: 39e2a02301d1d0b609fbc041395dd31f6ba9fa2d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - fixed grammar.Scott Rifenbark2012-10-011-1/+1
| | | | | | | (From yocto-docs rev: 57c3a8d32e0fab3a566eb5f0ac8b38a6786489f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: external SCM UpdateScott Rifenbark2012-09-241-3/+4
| | | | | | | | | | | Updated the section "Using an External SCM." This section was written so that PN was refering to a package instead of correctly refering to the recipe. (From yocto-docs rev: 2bf44cf78bef08d2dd4d9e596100900913777d60) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: package group changesPaul Eggleton2012-09-141-24/+26
| | | | | | | | | | | | | | | | | Task has been renamed to package group, and there are some minor changes in how package group recipes should be constructed - in particular the inherit of packagegroup.bbclass is now highly recommended as it will set appropriate defaults and automatically add complementary -dev and -dbg packages. In addition to Paul's patch, I added a couple <filename>/</filename> tags around some switch names to be consistent with manual formatting. (From yocto-docs rev: 598d18507ace2054f8c8bb5f496557c98f066b5a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: note on readmeScott Rifenbark2012-09-141-1/+4
| | | | | | | | | | | | Added a note in the "Creating Layers" section noting that to be Yocto Project compliant, a layer must contain a README file. This change was prompted by a discussion over the fact between Robert P. J. Day and Mark Hatle. (From yocto-docs rev: 2e073763a81125699a2d962031ca29ca64c81595) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: Packages dir removedScott Rifenbark2012-08-141-1/+1
| | | | | | | | | | Updated an old comment in the layers.conf file example to say we have recipes-* directories instead of the old packages directory. (From yocto-docs rev: c39394e848d6039e6728b7e53de86958f951e258) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: modified SSH server discussion for QEMU ImagesScott Rifenbark2012-08-141-0/+1
| | | | | | | | | | | Two areas of the manual updated to reflect the fact that not all QEMU images have an SSH server in them. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: a173d8cb05ee695b02188a037ee047db016c6a67) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Config fragment sections updatedScott Rifenbark2012-07-201-11/+35
| | | | | | | | | | | I have updated both the section for configuration fragments found in the BSP and dev manuals. Reported-by: James Abernathy <jabernathy@gmail.com> (From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: Fixed referenceScott Rifenbark2012-07-171-1/+1
| | | | | | | | | | Caught and fixed a stray reference to "appendix" that should be "chapter." (From yocto-docs rev: 97d26495dd9b561bb5724a86e9cd777eeef9f71a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: converted ref-images and ref-features to chaptersScott Rifenbark2012-07-171-1/+1
| | | | | | | | | | | | | As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-imagese" and "ref-features" appendices to chapters and made any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: Added external SCMScott Rifenbark2012-07-171-0/+24
| | | | | | | | | | | Added the section "Using an External SCM" to the "Common Tasks" chapter. This information was formerly in the YP Reference Manual in the old development chapter. (From yocto-docs rev: d34cd9e86cb7a6b27cf6a5b4daf58c445dd86331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: correct SMP_CONFIGPaul Eggleton2012-07-041-1/+1
| | | | | | | | | | It's CONFIG_SMP here, and since the title of the section already mentions it, just change the sentence to be more generic. (From yocto-docs rev: 32e6145b5f41d4eb293f8267ef01d02217143152) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Fixed "Linux Yocto" termScott Rifenbark2012-07-031-2/+2
| | | | | | | | | | | | | | | Throughout the manual, the kernels that are built and available through the Yocto Project were being referenced as a "Linux Yocto kernel." This reference is poor. First, it placed Linux and Yocto very close together and could upset the Linux folks. Second, a better way would have been to say "Yocto Linux kernel." I have fixed by referring to kernels that are available through the Yocto Project as "Yocto Project kernels." (From yocto-docs rev: 9b8319328cd4ab4ce3363001c9feeec585d9cab9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Scrub for Yocto Project termScott Rifenbark2012-07-031-109/+64
| | | | | | | | | | I have replaced the term "Yocto Project" with more appropriate terms where possible. (From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: Moved dbg and profileScott Rifenbark2012-06-211-0/+478
| | | | | | | | | | | Moved the sections on remote debugging and using the profile out of the YP Reference Manual and into the YP Development Manual. These are now two sections in the "Common Tasks" chapter. (From yocto-docs rev: 42640bf69aa05c56eb112c10b6d7b96069173785) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Moved temp source code mod into dev modelScott Rifenbark2012-06-151-323/+4
| | | | | | | | | | | | | | | | | The section "Modifying Temporary Source Code" that was in the chapter for "Common Tasks" was moved to the "Common Development Models" chapter. After discussion with Darren Hart, modifying temporary source code is a valid develop model. So, rather than isolate it in the common tasks chapter it has been placed in the development model chapter, which now has four types of development. Changes were made to update the introductory text of all the concerned areas of the manual. (From yocto-docs rev: 8b07ee3bcda9c13e576b54b0079b0656cd8fcc32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual-common-tasks.xml: Font corrected.Scott Rifenbark2012-05-011-1/+1
| | | | | | | (From yocto-docs rev: 18f790affe7697193765e034888d369490188313) 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-06 10:51:30 +0000