summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Add a note about prelink changing prebuild binariesRichard Purdie2020-10-301-0/+7
| | | | | | (From yocto-docs rev: 6c023ee1328bb31ececd9e1daaac67351c8320e3) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/dev-manual-common-tasks: fix typos and use extlinksNicolas Dechesne2020-10-271-4/+5
| | | | | | | | | | * fixed a couple of typos * added a 'nicer' link to the repo using :yocto_git: (From yocto-docs rev: 14d0c205c671c4c670d7a887d307d359f70e1b7a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/dev-manual-common-tasks: fix warningNicolas Dechesne2020-10-261-19/+16
| | | | | | | | | | | | | A new warning was introduced in 59908cecb528 (docs: Updated the status of spdx module.) The code-block section belongs to the #3 item in the enumerated list. While at it, also fixed a typo in the text. (From yocto-docs rev: 0e301503883222da702e2418404ee6f04a25dbc1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual: fix typos, highlights, indentation and linksQuentin Schulz2020-10-204-688/+566
| | | | | | | (From yocto-docs rev: ab244dcd48968ea6d0e328808c9aac4aef281032) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual-common-tasks: update python webserver example to python3Quentin Schulz2020-10-201-3/+3
| | | | | | | | | | | | SimpleHTTPServer is python2 only, the module in python3 is http.server. Let's use this one since everything in Yocto Project is using python3 nowadays. (From yocto-docs rev: 75338f17b116afadb7360181d071875a68272708) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDSQuentin Schulz2020-10-201-16/+7
| | | | | | | | | | | | | | Missing DEPENDS were an issue before rocko (2.4) because of a shared global sysroot. Since then, every recipe has its own sysroot, it is not possible to build successfully a recipe without all DEPENDS. Therefore, races in tasks possibly triggered by missing DEPENDS are a thing of the past. This paragraph is misleading and can be safely removed. (From yocto-docs rev: 9aec42794846a4bca37b49a9f920fa2887974ddf) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Updated the status of spdx module.leimaohui2020-10-201-0/+38
| | | | | | | | | | - Deleted content about old spdx.bbclass. - Added usage of meta-spdxscanner. (From yocto-docs rev: 59908cecb5283ebdea1800c4d86a6310a45159bf) Signed-off-by: Lei Maohui <leimaohui@cn.fujitsu.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/test/ref-manual: Fix typosNaoki Hayama2020-10-201-1/+1
| | | | | | | | | | | Fix some typos. s/necesary/necessary/ s/overriden/overridden/ (From yocto-docs rev: f4ce6ae80b1d96f9b8bead013642aeda0c776182) Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UKRichard Purdie2020-10-086-6/+6
| | | | | | | | | | | When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: remove DocBook filesNicolas Dechesne2020-10-067-19379/+0
| | | | | | | | | | The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix broken linksQuentin Schulz2020-09-223-12/+13
| | | | | | | | (From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: replace special quotes with single and double quotesQuentin Schulz2020-09-174-14/+14
| | | | | | | | (From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual: Clarify that virtual providers do not apply to runtime ↵Joshua Watt2020-09-171-0/+6
| | | | | | | | | | | | | | dependencies Clarifies that virtual providers are only used for build time dependencies specified with PROVIDES and DEPENDS, and do not apply to runtime dependencies specified with RPROVIDES and RDEPENDS. (From yocto-docs rev: dbca49573ce5c5c006c97f79d1107eafee83dc10) Signed-off-by: Joshua Watt <Joshua.Watt@garmin.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual: Various URL, code block and other fixes to imported dataRichard Purdie2020-09-174-1540/+3200
| | | | | | (From yocto-docs rev: 8e73d870e9dc2df416f5c5cf5b10ef552be0aa6d) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: insert blank below between title and tocNicolas Dechesne2020-09-171-0/+2
| | | | | | | | | | Whenever a TOC follows a title/heading, a blank line is missing. So let's add it explicitely. (From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: manuals: Move boilerplate after toctreeRichard Purdie2020-09-171-2/+2
| | | | | | | | | The boilerplate looks better after the ToC, still not quite right but the boilerplate can be improved from here. (From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: history: Move revision history to its own sectionRichard Purdie2020-09-172-62/+68
| | | | | | | | | The revision history tables look better in their own section, move them. (From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add links to section in the Bitbake manualNicolas Dechesne2020-09-171-16/+16
| | | | | | | | | | Use intersphinx extension to replace links to the Bitbake manual with proper cross references. (From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add links to terms in the BitBake glossaryNicolas Dechesne2020-09-171-3/+3
| | | | | | | | | | | | | | | | | Using the intersphinx extension, we can refer to terms in the Bitbake manual using :term:`bitbake:FOO`. This patch implements that, mostly using the following regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_BB_URL;)?#var(-bb)?-\\1>`__", ":term:`bitbake:\\1`", line) And a handful of manual fixup. (From yocto-docs rev: d2ed9117fffceb756c4a8f3cb6d39363a271d6d9) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix links when the link text should be displayedNicolas Dechesne2020-09-172-18/+18
| | | | | | | | | | | | | | | | | When an hyperlink should be display in the output, there is no need to any specific syntax or marker, the parser finds links and mail addresses in ordinary text. Somehow the conversion from pandoc generated wrong output in the form: ` <link>`__. This patch is generated using the following Python regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) (From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add links for Yocto project websiteNicolas Dechesne2020-09-173-32/+28
| | | | | | | | | | | | | | In DocBook, variables are used to create custom links (note that it is not consistent everywhere, since some web addresses are still hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL, YOCTO_BUGS_URL and YOCTO_DL_URL.. In Sphinx they are replaced with extlinks. (From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual add figuresNicolas Dechesne2020-09-171-0/+18
| | | | | | | (From yocto-docs rev: 590ddc11263f00d912d874377199574c123c75b1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: manual updates for some linksNicolas Dechesne2020-09-173-97/+91
| | | | | | | | | | | Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix custom term linksNicolas Dechesne2020-09-171-6/+6
| | | | | | | | | | Some term links have custom 'text', and require manual update, since they were not caught by the generic Python regexp. (From yocto-docs rev: 519355ba9daf7630e8d477b2f6f511be51fd8b2e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix internal linksNicolas Dechesne2020-09-173-387/+387
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Many of the internal links were not converted probably from DocBook using pandoc. After looking at the various patterns, the follow series of 'naive' Python regexp were used to perform some additional automatic conversion. Also, since we rely on built-in glossary, all links to terms need to use the sphinx :term: syntax. This commit is generated using the following Python series of regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__", ":term:`\\1`", line) line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__", ":ref:`ref-tasks-\\1`", line) line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1.bbclass <ref-classes-\\1>`", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1 <ref-classes-\\1>`", line) line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__", ":term:`Source Directory`", line) line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__", ":term:`Build Directory`", line) line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__", ":term:`Metadata`", line) line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__", ":term:`BitBake`", line) line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__", ":ref:`ref-manual/ref-images:Images`", line) line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__", ":ref:`ref-manual/ref-classes:Classes`", line) line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__", ":ref:`devtool-the-workspace-layer-structure`", line) line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__", ":term:`OpenEmbedded Build System`", line) line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__", ":term:`OpenEmbedded-Core (OE-Core)`", line) It won't catch multiline strings, but it catches a very large number of occurences! (From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual: add revision history tableNicolas Dechesne2020-09-171-0/+62
| | | | | | | (From yocto-docs rev: 36d1073119081b9c364f48aedf4086881bef03d6) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add boilerplate to manualsNicolas Dechesne2020-09-171-0/+2
| | | | | | | (From yocto-docs rev: d552acdc60c8a0467b649b95183b87b3345a4f8c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: Add SPDX license headersNicolas Dechesne2020-09-175-0/+10
| | | | | | | | | | SPDX headers have been added to each file, and match the headers used in the DocBook files. (From yocto-docs rev: 79dbb0007ae24da4a3689a23e921f2a2638757f7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: initial sphinx supportNicolas Dechesne2020-09-175-0/+11603
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit is autogenerated pandoc to generate an inital set of reST files based on DocBook XML files. A .rst file is generated for each .xml files in all manuals with this command: cd <manual> for i in *.xml; do \ pandoc -f docbook -t rst --shift-heading-level-by=-1 \ $i -o $(basename $i .xml).rst \ done The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux). Also created an initial top level index file for each document, and added all 'books' to the top leve index.rst file. The YP manuals layout is organized as: Book Chapter Section Section Section Sphinx uses section headers to create the document structure. ReStructuredText defines sections headers like that: To break longer text up into sections, you use section headers. These are a single line of text (one or more words) with adornment: an underline alone, or an underline and an overline together, in dashes "-----", equals "======", tildes "~~~~~~" or any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel comfortable with. An underline-only adornment is distinct from an overline-and-underline adornment using the same character. The underline/overline must be at least as long as the title text. Be consistent, since all sections marked with the same adornment style are deemed to be at the same level: Let's define the following convention when converting from Docbook: Book => overline === (Title) Chapter => overline *** (1.) Section => ==== (1.1) Section => ---- (1.1.1) Section => ~~~~ (1.1.1.1) Section => ^^^^ (1.1.1.1.1) During the conversion with pandoc, we used --shift-heading-level=-1 to convert most of DocBook headings automatically. However with this setting, the Chapter header was removed, so I added it back manually. Without this setting all headings were off by one, which was more difficult to manually fix. At least with this change, we now have the same TOC with Sphinx and DocBook. (From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* virtual/libgbm is the provider of gbm.pcJoshua Watt2020-07-161-1/+1
| | | | | | | | | | | Providers of libgbm (including mesa) have move to the "virtual/libgbm" name to provide this functionality. Update the documentation to prevent confusion. (From yocto-docs rev: afc290e85bc801549000a6f6d770e2975a313779) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Add SPDX License headersakuster2020-06-177-0/+10
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: eaded98195eed8adf3bba89a6b49a45383955785) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add PACKAGE_ADD_METADATA documentationMichael Ho2020-05-271-0/+58
| | | | | | | | | | | Add a basic variable definition and a small section to the development tasks manual for using PACKAGE_ADD_METADATA to add custom metadata to packages. (From yocto-docs rev: c5e4d575a771ddd1c970389ce3ace6d6abe68769) Signed-off-by: Michael Ho <Michael.Ho@bmw.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove postinst false statementMaxime Roussin-Bélanger2020-04-151-2/+0
| | | | | | | | | | This outdated section contradicts the real behavior expressed in the next paragraph (From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b) Signed-off-by: Maxime Roussin-Bélanger <maxime.roussinbelanger@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: basic updates for npm fetcher changesPaul Eggleton2020-04-151-31/+21
| | | | | | | | | | | 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 <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: clarify how to select "read-only-rootfs"Robert P. J. Day2020-04-071-9/+9
| | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: use "git", not "apmd", to explain checksum namesrpjday@crashcourse.ca2020-04-061-8/+9
| | | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: use "strace" for PV example, not cdrtoolsrpjday@crashcourse.ca2020-04-061-4/+4
| | | | | | | | | | | | | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: buildtools versions and changesTim Orling2020-04-061-5/+8
| | | | | | | | | | | | Bump tar, Python versions and add new gcc requirement. Update reference from 'required-git-tar-and-python-versions' to 'required-git-tar-python-and-gcc-versions' (From yocto-docs rev: 18b11662c7c9ab7828d2709eed4090116a751e14) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentaiton: Change author infoakuster2020-04-061-3/+2
| | | | | | | | | | Update the author indo and use variables for author and email to make it easier to change in future. (From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* correct mention of "postinst_intercept delay_to_first_boot"rpjday@crashcourse.ca2020-04-061-1/+1
| | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"rpjday@crashcourse.ca2020-04-061-2/+2
| | | | | | | | | | | | | | | Given the defined DocBook entity: <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs"> replace numerous instances of the more verbose "&YOCTO_HOME_URL;/documentation", which is a redirect, anyway. rday (From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: minor tweaks, rewording, grammar for chapter 2rpjday@crashcourse.ca2020-04-061-26/+28
| | | | | | | (From yocto-docs rev: 706386ac094479916e1cc482e56a6433caa85e1a) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: clarify PN usage in packagegroup filesrpjday@crashcourse.ca2020-04-061-6/+10
| | | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: add missing check to yocto-check-layer sectionrpjday@crashcourse.ca2020-04-061-1/+20
| | | | | | | | | | 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 <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: use actual machine override demonstrationrpjday@crashcourse.ca2020-04-061-5/+19
| | | | | | | | | | | | Given that the section in question is describing how to configure dependencies based on the machine type, it seems inappropriate to use an example that depends on the choice of C library, so grab a snippet from linux-yocto.inc to really drive the point home. (From yocto-docs rev: 66bfec015f61a690f96cf8e28b80869c77327e6d) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: explain LAYERDEPENDS with other layer.conf varsrpjday@crashcourse.ca2020-04-061-0/+4
| | | | | | | (From yocto-docs rev: 2d56b38e1a1d4a89c0ed46af93791fe1fbdfecc9) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fix CROPS linkAlejandro Hernandez Samaniego2020-04-061-2/+2
| | | | | | | | | | | | | | The link used in the documentation points to a file that no longer exists on the crops repository. Use the poky-container repo instead since it is more accurate and updated (From yocto-docs rev: 5d16ccecf0b198af0f78a4cce28532ab9dca739f) Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org> Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks.xml: Replace "QemuTarget" with "qemu"Yeoh Ee Peng2020-04-061-2/+2
| | | | | | | | | | | | As the OEQA code revamp and code changes in testimage.bbclass, testexport.bbclass, runtime/context.py and oeqa/runexported.py, "QemuTarget" was obsolete and replaced by "qemu". Replacing the refer of "QemuTarget" with "qemu". (From yocto-docs rev: f89d18adb62bc864e7890a613ff860bd3e4279ed) Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks: Replace "SimpleRemoteTarget" with "simpleremote"Yeoh Ee Peng2020-04-061-4/+4
| | | | | | | | | | | | As the OEQA code revamp and code changes in testimage.bbclass, testexport.bbclass, runtime/context.py and oeqa/runexported.py, "SimpleRemoteTarget" was obsolete and replaced by "simpleremote". Replacing the refer of "SimpleRemoteTarget" by "simpleremote". (From yocto-docs rev: 41823811229754805c682ecec6903399bfe606fe) Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Document the WSLv2 install processAlejandro Hernandez Samaniego2020-04-061-6/+141
| | | | | | | | (From yocto-docs rev: 65e3a1b3c82475f706418b8ec7d0e6bed34b382b) Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org> Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>