summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Updated for a 2.5.1 releaseScott Rifenbark2018-08-151-0/+5
| | | | | | | | | | | | poky.ent - updated variables for 2.5.1 mega-manual.sed - updated string from "2.5" to "2.5.1" <manual>.xml - updated manual revision tables for 2.5.1 and September 2018 date (From yocto-docs rev: a47382f00ad1a5a1df02ffa3dead7a0bd597bf45) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed "newbie" chapter.Scott Rifenbark2018-05-243-629/+627
| | | | | | | | | | | | | This chapter only had the stuff about submitting a defect against YP and making a change to YP. I moved that information into the common tasks chapter as it is "how-to" information. Removal of this chapter alse required that the mega-manual.xml file be updated to not include the chapter. (From yocto-docs rev: 4421b1585c21a6f7862525ba972f7e765626066e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Speeding Up the Build" and renamed it.Scott Rifenbark2018-05-242-163/+158
| | | | | | | | | | | Renamed to "Speeding Up a Build" and moved out of the setting up chapter to the common tasks chapter. Fixed a couple links in the ref-manual. (From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Software from an External Source" section.Scott Rifenbark2018-05-241-75/+75
| | | | | | | | | | This section is now organized under the parent "Building" section in the common tasks chapter. (From yocto-docs rev: bc1bc9965cda547e45ff09a1c9e77be5e8c0a3d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Images for More than One Machine" section.Scott Rifenbark2018-05-241-198/+198
| | | | | | | | | | This section is now organized inside the parent "Building" section in the common tasks chapter. (From yocto-docs rev: 71be83e1ebfd2ad8606bddf852a4c06ab7d7c53d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building a Tiny System"Scott Rifenbark2018-05-241-427/+425
| | | | | | | | | | This section is now part of the building parent section. I have moved it there in the common tasks chapter. (From yocto-docs rev: a9fccb1bca8e18169d93416c7a6e17723bcf01c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building an Initial RAM Filesystem (initramfs) Image"Scott Rifenbark2018-05-241-139/+105
| | | | | | | | | | This section now belongs under the parent "building" section in the common tasks chapter. (From yocto-docs rev: dad6029b9b45fd6ec564894ba101991fd8a2162e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Targets with Multiple Configurations"Scott Rifenbark2018-05-241-96/+95
| | | | | | | | | | This is a "building" topic. I moved it beneath the new parent "building" section. (From yocto-docs rev: 0426f0dd6871c8063476945b93743ffc5cfc0856) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved the "Simple Build" sectionScott Rifenbark2018-05-242-140/+165
| | | | | | | | | | | | | I had a section on building an image up in chapter that talks about getting set up to use YP. I moved the build section to a new parent section that will hold topics on building various things. I renamed the section to "Building a Simple Image". I had to fix several links in the sdk-manual, overview-manual, and dev-manual. (From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Pulled cloning sections up into a parent section.Scott Rifenbark2018-05-241-26/+30
| | | | | | | (From yocto-docs rev: 68ef556831f687e25e3f4df068db4ea86bffb3b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated intro paragraph to exclude removed sectionsScott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 886ec9153314acbdcfa510806b441ba02c0bdd2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-241-3/+3
| | | | | | | | | | Changed to "Locating Yocto Project Source Files". I am moving the sections on cloning repositories out from under this section. (From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed title to remove redundancyScott Rifenbark2018-05-242-2/+2
| | | | | | | | | | | The "Setting Up the Development Host to Use the Yocto Project" title changed to "Preparing the Build Host". Fixed links in a lot of other manual. (From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved section on setting up a team YP environmentScott Rifenbark2018-05-242-372/+374
| | | | | | | | | | | This section was in the chapter on the open source development environment. It is better suited to be in a newly named chapter "Setting Up to Use the Yocto Project". I have moved it. (From yocto-docs rev: 028f8f7a1b93a023a99ffadb01b0da699b4081c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated intro chapterScott Rifenbark2018-05-241-19/+16
| | | | | | | | | | The chapter was not the best given the new nature of the manual. I added better introductory wording. (From yocto-docs rev: cb4695575c0105e0cd5e50c2132e98553babe147) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved licensing how-to stuff to dev-manualScott Rifenbark2018-05-241-202/+591
| | | | | | | | | | | | The section on licensing in the overview-manual was really "how-to" information. I moved this to a new section in the dev-manual for "working with licenses". I fixed some references in the ref-manual and in the bsp-guide as well. (From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Enabling Runtime Tests on QEMU"Scott Rifenbark2018-05-241-0/+19
| | | | | | | | | | | | Fixes [YOCTO #12517] Added some qualifying information for how to generate a list of tap devices to enable runtime tests on QEMU. (From yocto-docs rev: 4359a355944f6cf4ec1e14ecbedc690ef37ff743) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved Wayland and WestonScott Rifenbark2018-05-241-0/+130
| | | | | | | | | | | The Wayland and Weston topic moved from the overview-manual to the dev-manual. The topic was really a "how-to" topic and not a concepts topic. (From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved sstate debug tips sectionsScott Rifenbark2018-05-241-0/+92
| | | | | | | | | | | | Two sections at the end of the shared state concepts section in the overview-manual are really task sections. I took those and created a couple new sections in the dev-manual to house those topics. (From yocto-docs rev: 86382e7873d796f44554c8e04d3bd8091d350f51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: New section in QEMU for workaround under KVMMartin Kelly2018-05-241-0/+34
| | | | | | | | | | | | | | As suggested in a recent mail thread by Martin Jansa, there are cases in which QEMU under KVM will crash because of CPU feature incompatibilities between compiled binaries and the host CPU under which qemu is run. Although this is hard to fully escape, we should document the issue to help people work around it. I have taked Martin's suggested patch and did some rewording for the new section. (From yocto-docs rev: 6c625fcf631a82529bc58ec8fb0c18dbe13188d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Enabling Your Layer" section.Scott Rifenbark2018-05-241-7/+9
| | | | | | | | | The bblayers.conf example files were out of date. Updated them. (From yocto-docs rev: fd5d75604a3ad66e56c421634f349dce3e38f609) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated wording for Manage Granular Level PackagingScott Rifenbark2018-05-241-1/+2
| | | | | | | | | | Changed wording to be clear about how PACKAGE_ARCH is being set when based on the Freescale MACHINE_SUBARCH variable. (From yocto-docs rev: 76c4ad514e44755f1d4dcec61bb0a74c1b77243e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated managing granular level packaging discussion.Scott Rifenbark2018-05-241-32/+43
| | | | | | | | | | | | | | In the section that talks about building an image for multiple machines, there was a bullet item on managing granular level packaging. It had an old example that used the "daisy" release that showed how to share packages and re-use binaries. I replaced the example with a discussion of Freescale's "fsl-dynamic-packagearch" class, which does this type of sharing. (From yocto-docs rev: ddc224d6d1fe172292dfd0a17f743a1e0a4cabe6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed Wic example paths to be consistent.Scott Rifenbark2018-05-241-3/+3
| | | | | | | (From yocto-docs rev: 402434dd15f3116307e690ecc09db875ecabded4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated Wic exampleScott Rifenbark2018-05-241-26/+24
| | | | | | | | | | | I updated the first example in the section telling how to build out a Wic image. I could not get the example to run so I used Stephano's output. (From yocto-docs rev: 6b4595215d6c24e3efb89288a7547f79ca3e59b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Cleaned up links to source reposScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | I was using the "/cgit/cgit.cgi/" string as part of the link to the source repos, which uses the ENTITY "&YOCTO_GIT_URL;". That ENTITY is all that is necessary to get the link to work. I removed the other stuff. (From yocto-docs rev: f9a63c2cc824ef05230f614e933d178469890e97) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken linkScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4abc25e1b0b93bb232291e0bb51ec89c5e1f66f9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to WORKDIR variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: c239bd40e92cedee6301c176ff96821ea270fc39) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced SERIAL_CONSOLE with SERIAL_CONSOLESScott Rifenbark2018-05-241-1/+1
| | | | | | | | | The former is deprecated. (From yocto-docs rev: 1a1f89d91ceeb35f8cb5c2f9fc42fdb089ffc05c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to Carna Botnet's article.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1d5e9bfea217051a457c30dcbd890366e9dd7611) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed target for a link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 59697f22f79d07b800d4f3ce2eb2ea41c987802b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed non-functioning link to EXTERNAL_TOOLCHAINScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: b0bd0c4d8070adf1439140230700b0de18f884ae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced "BSD" with "BSP" typo. Also small word change.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: d67856c849c5275a07ee1f87db839cd4d4d9a6f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Terminology fix for "OpenEmbedded Layer Index"Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Found several instances of this being referred to as the "OpenEmbedded Metadata Index". Changed to "OpenEmbedded Layer Index". (From yocto-docs rev: 60fb601be324a350cd4d51b199915e6b72e2f9b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed redundant link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: bf64aad87e0248362e9cf9b693cd806ca32873fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed formatting issue.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4cd711d1305f480068447bac8881212a5b999d34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Slight wording change and link to a list of items.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 26dd48f6995a1ac8da5ceba124d7795ebe857d53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed a broken Gitolite link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 5d900f38079701a2ed8243071bd669bca1d97e1e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed link to Toaster User Manual.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Had "Toaster Manual" in the cross-reference so it was not resolving correctly when processed by mega-manual.sed. (From yocto-docs rev: c99ce4a706df55e97388b45620ed2a503cb8312d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed writer note about needing a figure.Scott Rifenbark2018-05-241-3/+8
| | | | | | | | | | | Nobody provided a figure for me for this section, which would have been nice. So, I have generalized the text to work without that detail. (From yocto-docs rev: 7570167196c26c9eb08e97d1350a715bff37c75f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar... missing word.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 37cf33513896f2cf9accf801b0847d9f132fc06a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Cleaned up links to the source repositoriesScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | I was using the ENTITY with "cgit/cgi"/ appended to the end. The appended part is not necessary. Removed it. (From yocto-docs rev: 64593694d62c99cbe2897804c04fea24110ee861) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-243-25/+25
| | | | | | | | | | | | | | | | | This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Fixed two broken links.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1ce02bf1c81629d9e008c05b48c4cddad264bafc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-243-5/+5
| | | | | | | | | | | Throughout the documentation, the manual "Getting Started With Yocto Project" was used. The manual now is called "Yocto Project Overview and Concepts Manual". (From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to old concepts-manualScott Rifenbark2018-05-242-21/+25
| | | | | | | | | | | | | The concepts-manual is going away for 2.5. I have fixed all the links across the YP documentation set that were cross-referencing into the concepts-manual so they now cross-reference into the getting-started manual, where that concepts chapter will live post 2.4x. (From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-mnaual: Changed "Dockers" to "Docker"Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: af6bf8474462584b183005ce51fec42efb94e232) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar error.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: a0f045418cb378ec07725dfd6de20b5d7ce33239) Signed-off-by: Scott Rifenbark <srifenbark@gmail.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-12 01:39:42 +0000