linux/poky.git/documentation/kernel-dev/kernel-dev-advanced.xml, branch dunfell-23.0.26

sphinx: remove DocBook files

2021-01-04T10:55:01+00:00

The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469) Signed-off-by: Nicolas Dechesne (cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: import docs

2021-01-04T10:55:00+00:00

The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

kernel-dev: Fixed a few links throughout manual.

2018-05-24T16:16:16+00:00

The areas were found scrubbing the mega-manual. These were minor fixes. (From yocto-docs rev: aaa460be3f4a446c091d66a17ca6c010f335ccc4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation: Updated everything for new overview-manual

2018-05-24T16:16:13+00:00

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 Signed-off-by: Richard Purdie

kernel-dev: Clean up of "bsp_name" placeholder.

2018-03-25T08:41:13+00:00

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 Signed-off-by: Richard Purdie

documentation: Created new "Getting Started" manual.

2018-02-14T15:25:29+00:00

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 Signed-off-by: Richard Purdie

documentation: Created new YP Overview Manual

2018-02-14T15:25:27+00:00

Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

kernel-dev: Fixed typo.

2017-10-16T22:46:53+00:00

Reported-by: Andrea Galbusera (From yocto-docs rev: 8955c2f09a421976ce296806b572afb4c7841470) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

kernel-dev: Added KMACHINE and MACHINE descriptions for using metadata

2017-10-06T11:06:34+00:00

Needed to remove an old example that was showing how two BSPs could share the same KMACHINE value. I replaced it with corei7-based machines. Also noted that KMACHINE is for kernel mapping only whereas MACHINE is for the layer's BSP machine type. (From yocto-docs rev: c1dad2815b6fd1ed78e0dce0fecb422f342eaf14) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

kernel-dev: Removed note about KTYPE being optional in future.

2017-10-06T11:06:34+00:00

(From yocto-docs rev: 2ecf347fe5b9f60d29a5624bab2f57a7278fa9ab) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie