summaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide
AgeCommit message (Collapse)Author
2020-08-16Documentation: Prepared for 3.0.4 releaseakuster
(From yocto-docs rev: 9f51be3a11b7422aba3617a90a98336c3c75f71e) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-17Documentation: Prepared for 3.0.3 releaseakuster
(From yocto-docs rev: 9d522e747d2715aa0b2fe4c81cacc34bfad3e1a3) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-02-06Documentation: Prepared for 3.0.2 releaseakuster
Add release date for 3.0.2. (From yocto-docs rev: ac75b463b23ae6258c1e6f3bbdefc398f3a03d43) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16YP 3.0.1 Docs: Fixed manual revision tables.Scott Rifenbark
I had a duplicate "October 2019" release in the dev-manual. Also, I forgot the year for the "October 2019" release entry. (From yocto-docs rev: 1d2a6d6c4d0f283dcf2627c9494b204859edd340) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09YP 3.0.1 Documentation: Set up the 3.0.1 release.Scott Rifenbark
* Updated poky.ent * Updated mega-manual.sed * Updated <manual>.xml with release date (From yocto-docs rev: 6418138ce8d9f2fa1e3d4ef10ec6187584d15f2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23documenation: Changed "2.8" to "3.0".Scott Rifenbark
I was using "2.8" throughout the manual set instead of "3.0". Updated all aspects to "3.0". (From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12bsp-guide: More corrections to the BSP Kernel Recipe exampleScott Rifenbark
After reading this over, I needed to explicitly state the *.bb and *.bbappend file names. It is clear now. (From yocto-docs rev: 901b76d9f94c33da15382068dc933d765cddade5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12bsp-guide: Updated the BSP kernel recipe example.Scott Rifenbark
There were some issues with this. The example stated using an append file and the file was actually named as a regular recipe file. I fixed that. Also, I updated the PREFERRED_VERSION_linux-yocto variable from "4.12" to "5.0" to be more up-to-date. (From yocto-docs rev: 933a668ef73b417587b4a8091b834db220611bd6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07documentation: Cleaned up "plug-in"/"plugin" terminology.Scott Rifenbark
The YP manual set was using the plugin term inconsistently. It was appearing as "plugin" as well as "plug-in". The plugins in the project are all named without a hyphen. The term itself is either/or according to Google. I have changed all references to plugin so that they do not use a hyphen. (From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07bsp-guide: Updated the "beaglebone-yocto.conf" example.Scott Rifenbark
This listing had gone stale. I updated the actual listing to match what is in poky repository and adjusted the various variable explanations affected. (From yocto-docs rev: 44ccb6ea7301ffa43c89f7a4f28265ea28725f99) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07bsp-guide: Removed inaccurate "container layer" references.Scott Rifenbark
I left only the single mention of "container layers" and changed the example from "meta-intel" to OpenEmbedded's meta-openembedded layer. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 8aa4de2be19c001f19cc540e2f7b33ca71f6be60) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07documentation: Prepared for 2.8 releaseScott Rifenbark
poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" <folder>.xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07Documentation: Removed customization.xsl files for EclipseScott Rifenbark
The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15documentation: Preparing for 2.7 release.Scott Rifenbark
Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15documentation: Fixed bad target ID for the dev-manual.Scott Rifenbark
This fix involved a few other manuals. (From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Set up the 2.6 version of the docsScott Rifenbark
poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bsp-guide: Fixed MACHINE_EXTRA_RRECOMMENDS syntax in conf file exampleScott Rifenbark
Fixes [YOCTO #12628] The syntax for MACHINE_EXTRA_RRECOMMENDS was off in the machine.conf example. I have removed that leading space, which should not have been there. This matches the actual file in poky now. (From yocto-docs rev: 11e38c4c2b23f9a8ae9a0655a07af1a5682c24b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark
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>
2018-05-24dev-manual: Changed title to remove redundancyScott Rifenbark
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>
2018-05-24overview-manual, dev-manual: Moved licensing how-to stuff to dev-manualScott Rifenbark
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>
2018-05-24documentation: Removed release date ENTITYScott Rifenbark
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>
2018-05-24documentation: Added ENTITY variable to track a release date and yearScott Rifenbark
(From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bsp-guide: Fixed broken link to Raspberry Pi README.md file.Scott Rifenbark
(From yocto-docs rev: f3d4710eef845ef356072645597b3794cb19d08a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bsp-guide: Fixed bad link that was going to old kernel manualScott Rifenbark
Found a link going to the "kernel-manual" manual, which is no longer used. Changed to "kernel-dev". This was a fix so that I was using the proper ENTITY in the poky.ent file. (From yocto-docs rev: 787ee10c7764ffd6adfbd8ddb304ac686bf3e95f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bsp-guide: Shortened link to the YP Source Repositories.Scott Rifenbark
Removed the /cgit blah blah blah part. (From yocto-docs rev: 575a0d173d4b8706bc8ee966e6bfafdd96b38cad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Cleaned up links to the source repositoriesScott Rifenbark
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>
2018-05-24documentation: Updated everything for new overview-manualScott Rifenbark
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>
2018-05-24bsp-guide: Removed redundant word.Scott Rifenbark
(From yocto-docs rev: 199f892100f352f7c190aa3d7bac1b4a5e44dfb2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Changed getting-started manual titlesScott Rifenbark
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>
2018-05-24documentation: Fixed links to old concepts-manualScott Rifenbark
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>
2018-05-24documentation: Fixed "Getting Started" manual linksScott Rifenbark
There was inconsistent use when referencing the getting-started manual. The manual's name does not include the word "Manual". So, I cleaned this up across the manual set and also in the mega-manual.sed file, which was incorrectly processing the links to that manual that do not target a specific section. (From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Updated "OpenEmbedded-Core" terms.Scott Rifenbark
Throughout the manual set, I made sure that "OpenEmbedded-Core" and "OE-Core" appear with the hyphens. (From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bsp-guide: Swapped SERIAL_CONSOLES for SERIAL_CONSOLEScott Rifenbark
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>
2018-05-24bsp-guide: Updated SPL_BINARY discussion.Scott Rifenbark
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>
2018-05-24bsp-guide: Fixed note on title page to have correct title.Scott Rifenbark
(From yocto-docs rev: 30455141776c86def4721e4dbe97b0c0a6e27ddd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24Documentation: Updated Manual NotesScott Rifenbark
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>
2018-05-24bsp-guide: Added new section for creating layer using bitbake-layersScott Rifenbark
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>
2018-03-25bsp-guide: Updated BSP terminolgy and BBLAYERS orderingScott Rifenbark
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>
2018-03-25bsp-guide: Review edits to the kernel layer.Scott Rifenbark
Minor corrections. (From yocto-docs rev: f7fa509b461d4b187f7f91c184b2de3c619de5a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25bsp-guide: Removed deprecated tool sectionsScott Rifenbark
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>
2018-03-25bsp-guide: Minor edits to the licensing section.Scott Rifenbark
(From yocto-docs rev: a7d13e2e9f9a947e65f969422202f04784724063) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25bsp-guide: Updates to Reqs and Recommeds for released BSPsScott Rifenbark
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>
2018-03-25bsp-guide: Updated the section on developing a BSPScott Rifenbark
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>
2018-03-25bsp-guide: Fixed link to section.Scott Rifenbark
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>
2018-03-25bsp-guide: Updated BSP development flow figure.Scott Rifenbark
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>
2018-03-25bsp-guide: Scrubbed the BSP structure section.Scott Rifenbark
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>
2018-03-25bsp-guide: Edits to "Preparing Your Build Host to Work with BSP Layers"Scott Rifenbark
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>
2018-03-25bsp-guide: General edits to "BSP Layers" sectionScott Rifenbark
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>
2018-02-14documentation: Purged overview manual referencesScott Rifenbark
When I converted the Yocto Project Overview Manual to the Getting Started With Yocto Project Manual, I updated the strings for references from "&YOCTO_DOCS_OVERVIEW_URL" TO "&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command that did not take into account the text the might follow the link by saying "see such-and-such section in the Yocto Project Overview Manual." So, I had to hand fix these. Additionally, since I have moved a deeper concepts chapter that was in the getting-started manual to a new Yocto Project Concepts chapter, many of those links changed had to really go to the new manual instead. Those were fixed. (From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new "Getting Started" manual.Scott Rifenbark
Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>