linux/poky.git/documentation/dev-manual/dev-manual-common-tasks.xml, branch dunfell-23.0.10

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

dev-manual: remove postinst false statement

2020-04-15T21:56:23+00:00

This outdated section contradicts the real behavior expressed in the next paragraph (From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b) Signed-off-by: Maxime Roussin-Bélanger Signed-off-by: Richard Purdie

dev-manual: basic updates for npm fetcher changes

2020-04-15T21:56:23+00:00

Update the npm:// URL and the generated npm recipe, and remove references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in general. (From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

dev-manual: clarify how to select "read-only-rootfs"

2020-04-07T21:00:10+00:00

For stylistic reasons, clarify the use of both IMAGE_FEATURES versus EXTRA_IMAGE_FEATURES when configuring a read-only rootfs. (From yocto-docs rev: 4111e4e70a87400671455ddd873d802d40d6b587) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie

dev-manual: use "git", not "apmd", to explain checksum names

2020-04-06T15:53:24+00:00

The apmd recipe is no longer appropriate to demonstrate the use of SRC_URI checksum names as it has only a single SRC_URI URL, so pick a more illuminating recipe. (From yocto-docs rev: 7f391a0656442e7ee2f3dd48b848befb7f461aec) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie

dev-manual: use "strace" for PV example, not cdrtools

2020-04-06T15:53:24+00:00

Section 3.3.5, "Fetching Code", uses the cdrtools recipe as an example for showing the use of PV, but that's a bad example since the current cdrtools recipe file contains: SRC_URI = " \ ${SOURCEFORGE_MIRROR}/project/cdrtools/cdrtools-${REALPV}.tar.bz2 \ ... PV = "3.01a31+really3.01" REALPV = "3.01" which is not exactly the point the dev manual is trying to make, so replace with simpler strace recipe. (From yocto-docs rev: d865b0288a4162a8d4df9a2abde43875e3dc2ced) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie

correct mention of "postinst_intercept delay_to_first_boot"

2020-04-06T13:40:24+00:00

Migration to YP 2.5 contains incorrect description of routine for delaying to first boot. (From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie

dev-manual: clarify PN usage in packagegroup files

2020-04-06T13:40:24+00:00

Make it clear to the reader that they can use the much shorter form of ${PN} for the base packagegroup name, rather than typing it out in full. (From yocto-docs rev: 19915978c30bbf37b65d9887c78a23394779f079) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie

dev-manual: add missing check to yocto-check-layer section

2020-04-06T13:40:24+00:00

Add explanation of missing checks performed by yocto-check-layer, and fix one typo. (From yocto-docs rev: 231bb92fa4a9c044894f845b8d6d0b9498abfc49) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie