summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2017-06-22dev-manual: Updates to the section on submitting changes to YPScott Rifenbark
I added detail to the procedure about pushing a change to a contrib directory and then requesting a pull using the scripts. More detailed with examples. Also, clarified some wording in the section about submitting a patch through email. (From yocto-docs rev: 76a358ba588b0f36d14aef0a68efe30c4e16746a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated checkout by branchKristi Rifenbark
Example was incorrect. Fixed it. (From yocto-docs rev: 7ae1c636e7a8c0448515f339476327bcaf21e63c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: uClibc Replaced by musl from Yocto 2.2Changhyeok Bae
(From yocto-docs rev: ed7e62f5937576d7878eb955fda12c18e787db18) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Fixed spelling error "containe"Kristi Rifenbark
(From yocto-docs rev: cf8032bf7c3bc484b63ee46c195ee1537b1f817f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual, ref-manual: Re-wrote the introsScott Rifenbark
Fixes [YOCTO #11630] I updated both the introductory sections of the ref-manual and the dev-manual. These need to work more tightly with the projected YP documentation set. (From yocto-docs rev: 6a28537d03fad8a53198edc7f9a6229f4e58e551) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated first section title to "Welcome"Scott Rifenbark
I want this first section to be titled "Welcome" rahter than "Introduction." It is more in line with the YP QS and the YP ref manual. (From yocto-docs rev: 113b82c589c93a33a2a956790668e8c0a28894ec) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22yocto-project-qs: Updated "Welcome" section.Scott Rifenbark
I moved the bit about using a VM if you don't have a Linux machine to a note as it broke the natural flow of this section. Also, inserted a link to the comprehensive list of links and other documentation references to the existing list of other information. (From yocto-docs rev: 73750063580ef7bc20bd445adc3e2b0b01e2257f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22yocto-project-qs: Updated phonetic rendition of "poky"Scott Rifenbark
I changed from "Pah-key" to "Pah-kee", which is more universal and also matched what is used in the dev-manual terms section. (From yocto-docs rev: 843e832f2416b0e3b0e9d941bf7755f206517603) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Changes section head for sumbitting change to YPScott Rifenbark
Fixes [YOCTO #11630] I changed the section heading for the section that describes how to make a change to the YP. It was passive. I need it to be active and in line with the "how-to" dev-manual. (From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated the section on the YP development environmentScott Rifenbark
Fixes [YOCTO #11630] Extensively updated the development environment section by creating a task-oriented section. (From yocto-docs rev: d440f0b5ceb1aca57a73d8bced515ae0bd3188f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated "How to submit a change" section.Scott Rifenbark
Fixes [YOCTO #11630] The section on how to submit a change was pretty much a procedure section. I did some rewriting to make it more that way. (From yocto-docs rev: d7edce9268ee5cae96c09c79fe34d5d2dbb701e0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Fixed a DocBook issue with formatting "bug-id"Scott Rifenbark
I discovered a mis-placed block of DocBook text that was causing the string "bug-id" to appear in a random spot in the "Patch Submission Details" section. Re-ording this block fixed the problem. (From yocto-docs rev: 6cf0e8ff0d2b176c1faf492c7bdd7d38e23e4c98) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated syntax for oe-run-native scriptKristi Rifenbark
OE native script now requires a native tool as part of the command line. I added that to the example. Removed a bad help command at the end of the section. (From yocto-docs rev: 5eb965ea51d669ee3bac01050b42bee984572199) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Fixed two grammar errorsKristi Rifenbark
(From yocto-docs rev: 4e68646edf078c23e414a300b37cb30774b28be7) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Updated "Kernel Overview" sectionKristi Rifenbark
The list of supported kernels was out of date. Edited with updated information. (From yocto-docs rev: b287f76905637834ec6342285b99abd2c5594597) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Added "see also" informational note at beginning.Scott Rifenbark
(From yocto-docs rev: 3af3d821b6e26fd352223f3f4196e0e200614203) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Created "Working With Git Repositories" sectionScott Rifenbark
Fixes [YOCTO #11630] This new section has three new procedures for now: 1) cloning the poky repository, 2) checking out a branch based on an upstream repository branch name, and 3) checking out a branch based on an upstream tag name. More to be added for other key repositories. (From yocto-docs rev: 4cbcd952ba395b19be5374470a95630a4bc6ffa7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated the "poky" termScott Rifenbark
Applied some formatting and some links (From yocto-docs rev: a0881588fcf2314b6d7bcbfb7ee9b9d4d7a2ef2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Moved "Git" section to the ref-manualScott Rifenbark
Fixes [YOCTO #11630] The "Git" section in the dev-manual is really about concepts. There are a couple of examples that might or not might be allowed to ultimately stay. I have moved the section to the ref-manual. If those examples get replicated in the new dev-manual, I will update the "Git" section further. For now, however, these remain in this moved section. (From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual, ref-manual: Moved "Workflows" section to ref-manualScott Rifenbark
Fixes [YOCTO #11630] I moved the "Workflows" section to the ref-manual. This section is primarily concepts and needs to be out of the dev-manual, which is being reconstituted into a "how-to" manual. (From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22sdk-manual: Updated the note for building SDK InstallerScott Rifenbark
For development purposes, static libraries need to be present only in the SDK. We do not need those static libraries in the image for most scenarios. So, replace IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation. I updated the note to reflect this. Suggested-by: Maxin B. John <maxin.john@intel.com> (From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual, ref-manual: Moved "Licenses" section to ref-manualScott Rifenbark
Fixes [YOCTO #11630] Moved the "Licenses" section from the dev-manual to the ref-manual. The information in the section is purely reference material and does not belong in the dev-manual, which is being reconstructed as a "how-to" manual. (From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated the LAYERRECOMMENDS variable descriptionScott Rifenbark
Fixes [YOCTO #11579] I removed the sentence about throwing an error or warning. (From yocto-docs rev: cfa3b1559122ec9e927ccd34afa0e26e877486f9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Moved "Yocto Project Source Repositories" sectionScott Rifenbark
Fixes [YOCTO #11630] The "Yocto Project Source Repositories" section is purely conceptual and thus does not belong in the reconstituted dev-manual, which is converting to a "how-to" manual. I have moved this section to the ref-manual under "The Yocto Project Development Environment" section. Moving the section affected several things. Three figures that where in the dev-manual were copied and moved to the figures folder of the ref-manual. This required deleting them from the dev-manual and adding them to the ref-manual. The makefile had to be edited to move those figures into the ref-manual and delete them from the latest version of the dev-manual in order for the tarball of files to be correct when the manuals are made. Links to anchors within the moved section had to be fixed in various manuals. Links to the main section "id" had to be fixed to point to the ref-manual manual. (From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual, dev-manual: Moved "Open Source Philosophy" to ref-manual.Scott Rifenbark
Fixes [YOCTO #11630] The "Open Source Philosophy" section that was in the dev-manual is really conceptual reference information and has no place in the dev-manual, which is being re-written to be a "how-to" manual. I moved the section into the new "ref-development-environment.xml" chapter. No links were affected by this. (From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Re-org for "closer-look" chapterScott Rifenbark
Fixes [YOCTO #11630] The ref-manual needs expansion for the old "closer-look" chapter. This chapter previously held a detailed look at what happens when a user uses the YP to develop something. Now, the chapter needs to also contain YP development environment concepts (e.g. open- source philosophy, etc.), which are coming from the dev-manual. Because of this, I renamed the "closer-look.xml" chapter to be "ref-development-environment.xml". I also renamed the larger section that was formerly the entire chapter into its own section named "Development Concepts". Both these changes caused a few links to break. I fixed all the links from within the various manuals so they would find appropriate targets. I did some re-writing for introductory material to introduce the new chapter and the section on "Development Concepts". A new file ("ref-development-environment.xml") was added by basically renaming the "closer-look.xml" chapter. And, the tracking for "closer-look.xml" was deleted. (From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Re-organized the "Introduction" ChapterScott Rifenbark
I made some changes to better introduce this reference manual. Clarified the best scenario for using the manual. Removed the long list of manual descriptions as that can be referenced further down in the manual. (From yocto-docs rev: 8f4555aa387ab3bd3f90f5fcda1d343811ecc168) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Fixed broken links to "Source Directory" term.Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from dev-manual to ref-manual broke all the links to the "Source Directory" term. I fixed them. (From yocto-docs rev: d3a206b141e0b0c623362622ec73bbf44118071a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Fixed broken links to "build-system-term" termScott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke a single link to the "build-system-term" id. I fixed it. (From yocto-docs rev: 51bbfbb6030a5298fde1dc0e6f67332cfa59fae2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Fixed links for "metadata" term.Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke the links to the "Metadata" term. I fixed these. (From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Removed the "id" for "layer" term - unusedScott Rifenbark
(From yocto-docs rev: 6916dcb203425dd3b05dd0a05acc99a0bc00094e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual, sdk-manual: Fixed links for "cross-development-toolchain"Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke links for the "cross-development-toolchain" term. I have fixed these. (From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Fixed links for "build-directory" term.Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Fixed links in the "Yocto Project Terms" section.Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual caused many links local to that section to be incorrect. I scrubbed the section and fixed all the links. (From yocto-docs rev: 4b795159aa80184f26ff1181a564516840c373b2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Fixed links to "bitbake-term"Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual. Doing so caused all the links to the id "bitbake-term" to break. These had to be individually fixed. Discovered two unresolved references that were a consequence of moving that section to the ref-manual. These were fixed as well. (From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual, ref-manual: Reorganized "Other Information"Scott Rifenbark
Fixes [YOCTO #11630] The exhaustive list of useful links and references to other YP documentation existed in the dev-manual. This is not the correct place for this type of reference information. I have moved that list to the ref-manual where it should be. The dev-manual now simply provides a link into that section. (From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual, ref-manual: Reorganized Bugzilla informationScott Rifenbark
Fixes [YOCTO #11630] Reorganized the way the information about entering bugs using Bugzilla is arranged in the documentation set. The dev-manual now has a section that is purely procedural and steps the user through the process of logging a new bug in the Bugzilla system. The ref-manual has a conceptual section that introduces the YP implementation of Bugzilla by simply telling the user what it is and what what its purpose is. (From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Corrected grammar errorKristi Rifenbark
(From yocto-docs rev: 0d432a6890316207f93c149b865d4a9fc020bfa0) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Edited grammar errorKristi Rifenbark
(From yocto-docs rev: d02aedcd3cf9e30d5d1633ee234af3fcb4a570e3) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Edited intro para to devtool upgrade figureKristi Rifenbark
The introductory paragraph for this figure was a cut/paste problem from previous devtool figures. (From yocto-docs rev: c02a2a57889bbdcd7e83ab9e2458397189bbb980) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual, sdk-manual: Corrected grammar errorKristi Rifenbark
(From yocto-docs rev: ca0843e7651d25e37295094770ca3a97f9150bbc) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Updated "Kernel Modification Workflow" config file locationKristi Rifenbark
Warning in step 5 indicated the wrong location for config file. Updated with new location and referenced an illustration to show an example. (From yocto-docs rev: e853e5b89f1dbd7399909064b50bc59e06302560) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Removed last paragraph of BSP workflow section.Scott Rifenbark
This paragraph had some links to old stuff. Removed the whole paragraph. (From yocto-docs rev: 95c1f348ed018c697cc996bc962787ede056b94b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual, mega-manual: Updated kernel overview tree structure figureScott Rifenbark
This figure was a bit out of date. I updated a few of the file names. Figure needs to reside in the Figures folder of both the dev-manual and the mega-manual. (From yocto-docs rev: 1e76477810b6be095f9ca190c9a8f0276ee4b8f9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Slight wording change to be clear.Scott Rifenbark
(From yocto-docs rev: f8b0f3e01249ab94520137ecc60dcc08620a2a96) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: changed git configuration file nameScott Rifenbark
I changed the git config file to ~/.gitconfig (From yocto-docs rev: 0d4f43944b911ee23dd03b5f503173478d6c396d) Signed-off-by: Scott Rifenbark <scottrif@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14dev-manual: Formed ordered list for email patch procedureScott Rifenbark
The section that describes how to create a patch and send it via email is really an ordered procedure. I recast the list of steps using numbers instead of bullets. (From yocto-docs rev: c2d2256ca6d8c8b837bae87a5bd8a3118553935c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14ref-manual: Updated PACKAGECONFIG_CONFARGS variableScott Rifenbark
Fixes [YOCTO #11600] Removed the example. It was not needed. (From yocto-docs rev: 402bb173b00a665fb55a8f740a4dbe60ead57f25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14ref-manual: Added warning to native.bbclass for naming conventionScott Rifenbark
Fixes [YOCTO #11411] Added a naming convention warning to the native.bbclass description that is similar to the existing warning used in the description for the nativesdk.bbclass. (From yocto-docs rev: 2ceeb5416d439197e94640229e3685ab8b87e0fb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14ref-manual: Updated PACKAGECONFIG_CONFARGS variable descriptionScott Rifenbark
Fixes [YOCTO #11600] "configure" and "cmake" are not do_* tasks of BitBake. I updated the formatting of these programs and removed links that were to the tasks in the reference manual. (From yocto-docs rev: 2605c7378f6b4b49c2e2baaf159fd2c289d83a1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>