summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* brief-yoctoprojectqs: Changed titleScott Rifenbark2018-05-241-41/+1
| | | | | | | | | | | Changed the title to "Yocto Project Quick Build" from "My First Yocto Project Build", which sound a bit too much like "My first little Pony." (From yocto-docs rev: c797590d3cd341a9c492c7af49a927e1d241184e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Swapped SERIAL_CONSOLES for SERIAL_CONSOLEScott Rifenbark2018-05-241-2/+2
| | | | | | | | | The latter has been deprecated. (From yocto-docs rev: 1f0f423f89d7727aace64b2cfe0b11b0a4bbc7e3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated SPL_BINARY discussion.Scott Rifenbark2018-05-241-10/+4
| | | | | | | | | | | | Updated the discussion on this variable in the BeagleBone example. Took out an older "Xloader" term. Also, fixed a link to the u-boot.inc file. (From yocto-docs rev: 5a41c6e7ed6ee6432f7f2c15642f5f98460a1a83) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated wording to use ENTITY variablesScott Rifenbark2018-05-241-4/+4
| | | | | | | | | | | The tip box shows how to ure the mirrors for the most recent release and the most recent release minus one. I set these up to use variables rather than hardcoded releases. (From yocto-docs rev: ad47deb8ac1fc074ed3fdf3627609ac3ab38e92b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added variables for doc version minus oneScott Rifenbark2018-05-241-0/+1
| | | | | | | | | | Useful for providing the release version of the current release minus one. (From yocto-docs rev: c5970a4c52a333156336a564ae488b808a73a880) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added link to getting started manual.Scott Rifenbark2018-05-241-0/+9
| | | | | | | | | | Provided a bullet item to the Getting Started manual in the "Where to Go Next" section. (From yocto-docs rev: ce4edc521d19b3c8025e950061cc962ca88fa29e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed duplicate linkKristi Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 53da7ae95f499bcfb80d4f04b834bf6ade71d2ff) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Fixed note on title page to have correct title.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 30455141776c86def4721e4dbe97b0c0a6e27ddd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS variableJoshua Watt2018-05-241-2/+19
| | | | | | | | | | Describes the new wildcard syntax (From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438) Signed-off-by: Joshua Watt <jpewhacker@gmail.com> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-2412-166/+315
| | | | | | | | | | | | | I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Added new section for creating layer using bitbake-layersScott Rifenbark2018-05-241-58/+488
| | | | | | | | | Created detailed example using the BeagleBone BSP. (From yocto-docs rev: 7701dc2bd94ae7ee3e4aee37ac97174ad445d286) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added variable description for SPL_BINARYScott Rifenbark2018-05-241-0/+42
| | | | | | | (From yocto-docs rev: 00e579123540006c364f7751a37e29c74acf361b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_BOOT_FILES varaible.Scott Rifenbark2018-05-241-9/+16
| | | | | | | | | | | | | Added a final paragraph that provides some cross-referencing to the sections that describe how to use Wic and to the Wic reference chapter. Also, shortened the DOC info line. (From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SERIAL_CONSOLE and SERIAL_CONSOLES variables.Scott Rifenbark2018-05-241-3/+5
| | | | | | | | | Added a link to the "getty" term. (From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated IMAGE_INSTALL variable description.Scott Rifenbark2018-05-241-6/+6
| | | | | | | | | Minor edits for clarification. (From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated EXTRA_IMAGECMD variable.Scott Rifenbark2018-05-241-3/+3
| | | | | | | | | | Added minor edits to clarify that we are talking about an image type. (From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added an id tag for the create layer step.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 59b8c053f8fe94cc51ece86733c435ac7085eb57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Create Your Own Layer" sectionScott Rifenbark2018-05-241-88/+71
| | | | | | | | | | | Updated the explanation of the layer.conf file. I am going to use this section as the definitive section that explains the layer.conf file. (From yocto-docs rev: 4c70c7467f0ca5cf2346ef8d10bde437b971d2d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Creating Your Own Layer" section.Scott Rifenbark2018-05-241-9/+15
| | | | | | | | | | Added information to the list of variables used in the layer.conf file to specify LAYERSERIES_COMPAT. (From yocto-docs rev: c41ff41e75b654d5d7df8c2a1e83ba5525490285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Creating Your Own Layer" section.Scott Rifenbark2018-05-241-2/+9
| | | | | | | | | | For step 3 on creating the layer, I put in wording to make sure the user does not create a layer in the cloned poky directory. (From yocto-docs rev: 1a0d1d0c0cdfa77c6df005d0294d11a02ca3770c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated layer creation example to use $HOME directoryScott Rifenbark2018-05-241-2/+3
| | | | | | | | | | | Best practices dictate that the use not create a layer in the poky repo. So, I updated the example to move the user to a top-level directory first and then create the layer. (From yocto-docs rev: 81ab8b0f393f90785880aec7685c4c431cb7ad87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable description LAYERSERIES_COMPATScott Rifenbark2018-05-241-0/+44
| | | | | | | | | | | Created a new variable description in the glossary. This variable is used in the layer.conf file and needed to be documented. (From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added two Minus-1 variables for release code namesScott Rifenbark2018-05-241-0/+2
| | | | | | | | | | | | Many examples in the YP set use the latest release code name as part of a list and then the "minus-1" code name is literally typed in. I think it is time to have a couple ENTITY variables in poky.ent that will fill in the last release for these examples. (From yocto-docs rev: 7421d6a0ae85503b205537f08cfd23e28747d835) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added new appendix for NeonKristi Rifenbark2018-05-243-11/+931
| | | | | | | | | Fixed [YOCTO #12417] (From yocto-docs rev: 9f6b874740b98c5b3eed1c06dcf5fbe687279ca8) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed Mars AppendixKristi Rifenbark2018-05-243-918/+2
| | | | | | | | | | | | | | | Fixed [YOCTO #12417] Deleted the appendix.xml file. Updated the mega manual .xml file to not include the Mars appendix file. Updated the sdk-manual.xml file to not include the Mars appendix file. (From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Clean up of "bsp_name" placeholder.Scott Rifenbark2018-03-252-15/+25
| | | | | | | | | | | | This string is now being presented as "bsp_root_name" in the YP manual set. A BSP name is essentially "meta-bsp_root_name". It was being presented in the manual set as "meta-bsp_name", which is not technically correct. (From yocto-docs rev: 9ad25836b2b3ca79aa3430be014871f50205cf9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated BSP terminolgy and BBLAYERS orderingScott Rifenbark2018-03-251-49/+61
| | | | | | | | | | | | | | Fixed the way we refer to a BSP name. It is really "meta-<bsp_root_name>" rather than "meta-<bsp_name>". The name is the whole string and not just the root name. Also added a tip on ordering the layers in the BBLAYERS variable in the bblayers.conf file. Order is important. (From yocto-docs rev: 9c56238295f5631c496377616ea98b860253e6f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added term "container layer"Scott Rifenbark2018-03-251-0/+14
| | | | | | | | | This is a layer that contains other layers (From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Cleaned up layer naming terminologyScott Rifenbark2018-03-251-60/+111
| | | | | | | | | | | | | | | | | | Reality dictates that the YP does not treat layer naming consistently. Layers are talked about as the "meta-whatever" layer and never the "whatever" layer. However, the tooling sometimes appends or uses just the "whatever" part of the layer name. A good example is the meta-yocto-bsp configuration file. All the variables in there use just the root name of a layer's name. In the manuals, I had been distinguishing the layer name as just the "whatever" part sans "meta-". I talked about the convention of using "meta-" in front of layer names, etc. Well, this is confusing in light of how everyone says a layer's name is "meta-whatever". So, I fixed all this up. (From yocto-docs rev: 79e52f6ccf4246fc69a460ce9d3a4a18720a9442) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the section on creating a general scriptScott Rifenbark2018-03-253-15/+53
| | | | | | | | | | | | | | Split this section into two sections: one for creating the layer using bitbake-layers create-layer and one for adding the layer to bblayers.conf using bitbake-layers add-layer. Needed to update some references in the yocto-project-qs and kernel-dev manuals. (From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Created tip for using server outside of build areaScott Rifenbark2018-03-251-6/+11
| | | | | | | | | | | | | | Fixes [YOCTO #12419] In the section on runtime package management, I created a "Tip" box to tell the user about using a location for the package index information outside of the "deploy" area of the hosts build directory. (From yocto-docs rev: 2aee814d3d3ed4052fca332693d5416907ae640e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to the section on creating a layerScott Rifenbark2018-03-251-11/+15
| | | | | | | | | Provided some key links to help clarify content. (From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Sanity edit through the layer creation sectionScott Rifenbark2018-03-251-1/+1
| | | | | | | (From yocto-docs rev: 91cda82ca148c56c18f059eeaa656d3561aed26d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Completed rewrite of runtime package managementScott Rifenbark2018-03-251-88/+197
| | | | | | | | | | | | Fixes [YOCTO #12419] This section was unclear and needed some work. I added text to help clear things up. (From yocto-docs rev: 54358a39a5710dbd0cbcfe8dafd2f641ec3863ef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGES_FEED_ARCHS variableScott Rifenbark2018-03-251-6/+15
| | | | | | | | | | | | | | | | Added the fact that this variable is really optional. If you don't use it then you are setting up a package feed URI that will include all supported arcchitectures for the package. Using it means you are setting up specific URIs for specific architectures. Added a "Tip" note box to show how you can use the variable to whitelist architectures. (From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_INSTALL variable description.Scott Rifenbark2018-03-251-36/+50
| | | | | | | | | | I created a two-bullet "Caution" note to highlight the stuff a user needs to be aware of that can cause problems. (From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Review edits to the kernel layer.Scott Rifenbark2018-03-251-8/+10
| | | | | | | | | Minor corrections. (From yocto-docs rev: f7fa509b461d4b187f7f91c184b2de3c619de5a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Added "cd poky" step after cloning example.Scott Rifenbark2018-03-251-0/+1
| | | | | | | (From yocto-docs rev: 3a05201aabc4633ffead17a01ed36cd25529595e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Review updates for minor wordings and linksScott Rifenbark2018-03-252-14/+17
| | | | | | | (From yocto-docs rev: 51dc5dd5362a8e6d6d558a566554bec34764227f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Removed deprecated tool sectionsScott Rifenbark2018-03-254-1855/+1497
| | | | | | | | | | | | | | | I took out the sections at the end of the manual that talked about the yocto-kernel tool. This tool is no longer maintained and there is no equivalent tool. I also fixed the yocto-bsp tool to be the bitbake-layers tool. This involved some consolidation of sections. I fixed some links in the kernel-dev and toaster-manual. (From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Minor edits to the licensing section.Scott Rifenbark2018-03-251-184/+232
| | | | | | | (From yocto-docs rev: a7d13e2e9f9a947e65f969422202f04784724063) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updates to Reqs and Recommeds for released BSPsScott Rifenbark2018-03-251-122/+198
| | | | | | | | | Updated this section with minor edits. (From yocto-docs rev: 1bc1dcda5fbab4a66737653164222f4fc5a7289c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated the section on developing a BSPScott Rifenbark2018-03-251-88/+117
| | | | | | | | | | This section had several out-of-date items. They are all up to date now. (From yocto-docs rev: 247f3eceeccc645a1b556aea433d4cf66399e962) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Fixed link to section.Scott Rifenbark2018-03-251-1/+1
| | | | | | | | | Wrong title used in link. (From yocto-docs rev: aa42a8752af97aaa4f16c89059eef63700ea48f4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated BSP development flow figure.Scott Rifenbark2018-03-252-0/+0
| | | | | | | | | This figure was out of date. (From yocto-docs rev: 8b649ab3c4667a45f263818c2532b18f2dae9464) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Scrubbed the BSP structure section.Scott Rifenbark2018-03-251-157/+226
| | | | | | | | | | | | | Made changes to sync the raspberrypi BSP example to what is really in the source directories. It was pretty out of date. Made some minor edits to the sections describing the framework of the BSP. (From yocto-docs rev: b222d0988cb365cb1943ee1857e5cfd6b9fe173a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Edits to "Preparing Your Build Host to Work with BSP Layers"Scott Rifenbark2018-03-251-20/+30
| | | | | | | | | | Applied some edits to make the section more up-to-date. Dumped minnow as a BSP example for raspberrypi. (From yocto-docs rev: a40515bad28d07d736e1ddd1832c19b074749d53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: General edits to "BSP Layers" sectionScott Rifenbark2018-03-251-18/+29
| | | | | | | | | | Added more relevant information around the discussion of BSP layers. (From yocto-docs rev: 8ca439b0bbfdcf390edb723fd12e8a00d90024e3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated example output for creating layerScott Rifenbark2018-03-251-5/+2
| | | | | | | | | | The example that creates a layer using bitbake-layers had old output. Updated it. (From yocto-docs rev: c58d738a59f113f8fffe0fc40b22e06b9d96cb6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits to manual upgrades for recipes.Scott Rifenbark2018-03-251-11/+18
| | | | | | | (From yocto-docs rev: 05307788395cb16af95e89592bda070be6c1a397) 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-11-14 02:51:59 +0000