summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* sphinx: Add SPDX license headersNicolas Dechesne2020-09-1766-0/+132
| | | | | | | | | | 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: switch to readthedocs themeNicolas Dechesne2020-09-171-1/+1
| | | | | | | | | | To install this additional theme: pip3 install sphinx_rtd_theme (From yocto-docs rev: 9121dbd0a457451d7f7cdffe8fa2717d5e5959ec) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: overview-manual: add figuresNicolas Dechesne2020-09-173-1/+66
| | | | | | | | | | The automatic conversion with pandoc skipped the figures. Add them manually. (From yocto-docs rev: 1c2d071b7963490e8126a0b81792bda7a7c0bc8c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-variables: use builtin sphinx glossaryNicolas Dechesne2020-09-171-7893/+7893
| | | | | | | | | | | | | | | | | | | | | | Sphinx has a glossary directive. From the documentation: This directive must contain a reST definition list with terms and definitions. The definitions will then be referencable with the 'term' role. So anywhere in *any* manual, we can do :term:`VAR` to refer to an item from the glossary, and create a link. An HTML anchor is created for each term in the glossary, and can be accessed as: <link>/ref-variables.html#term-<NAME> To convert to a glossary, we needed proper indentation (e.g. added 3 spaces to each line) (From yocto-docs rev: af16cc4233ae9672698cf2fbb7bf0a78e461122e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: initial sphinx supportNicolas Dechesne2020-09-1766-0/+49599
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* sphinx: add initial build infrastructureNicolas Dechesne2020-09-174-0/+87
| | | | | | | | | | | Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. (From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add documentation for kernel-fitimageUsama Arif2020-08-082-1/+217
| | | | | | | | | | | | This documents kernel-fitimage.bbclass as well as the variables that are required to use the class to create a FIT image. (From yocto-docs rev: 3aeca3b342e5be92be562f6dea6b71390c31b636) Signed-off-by: Usama Arif <usama.arif@arm.com> Cc: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic/bootimg-efi: Update docs for IMAGE_BOOT_FILES support in bootimg-efiKhasim Mohammed2020-07-282-2/+2
| | | | | | | | | | | | | | | List of files defined using IMAGE_BOOT_FILES are installed into the boot partition when preparing an image using the wic tool with the bootimg-efi source plugin. The corresponding code in bootimg-efi.py is updated to add this feature, the documentation is updated to reflect the change. Change-Id: I0d3ea8831440f4255e9d9bcf9f965c8b14331037 (From yocto-docs rev: 41ef4c9cb9882369f02826b6c096014a4d90ee67) Signed-off-by: Khasim Syed Mohammed <khasim.mohammed@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements: update supported hosts listsakuster2020-07-191-3/+4
| | | | | | | | | | drop Ubuntu 19, Fedora 28 & 29 Add: Fedora 31, 32 , Centos 8 and Ubuntu 20 (From yocto-docs rev: 08e25f2b2912b8b1102407f5a5f0169e8d5647ff) Signed-off-by: Armin Kuster <akuster808@gmail.com> 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>
* ref-manual: Add SPDX license headersakuster2020-06-2818-0/+21
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b7d60325c7ca02d38516781ea80376e465c5fd04) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Add SPDX license headersakuster2020-06-283-1/+4
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 0c975232996c11f0d6282879f361334c1fb82dd0) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: add SPDX license headerakuster2020-06-287-0/+9
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: f65ef78ab411d72249fa6889d32a055212a6ce02) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Drop obsolete edison/denzil branch conditionals3.2_M1Richard Purdie2020-06-171-54/+0
| | | | | | (From yocto-docs rev: 92120c56c125c6f3af1b1c0df2c9b984cfb2fdef) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: Fixed codeblock formattingMark Morton2020-06-172-55/+45
| | | | | | | (From yocto-docs rev: f9df2c8f68ba5732a2d83c99d2b9597ef66dc378) Signed-off-by: Mark Morton <mark.morton@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: Add SPDX license headersRichard Purdie2020-06-176-0/+8
| | | | | | | | [Yocto #13873] (From yocto-docs rev: 33ba40c062ca081dbcffc5400fb49e56d6f7f25e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* New source files and Makefile update for Test ManualMark Morton2020-06-179-0/+2184
| | | | | | | (From yocto-docs rev: d7cff640569a5772f3c366b4136762628fca534d) Signed-off-by: Mark Morton <mark.morton@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manaul: Add SPDX license headersakuster2020-06-177-0/+10
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 4e07e51e558cda76b870be98d9aeff1a6e7bb5b8) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Add SPDX license headersakuster2020-06-1710-0/+13
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 5b88e5e0f7a71ffefdd5e9c21520bf20692521c6) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Add SPDX licence headersakuster2020-06-177-0/+10
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 551c4a7f75e2afeb22d2638cc1e9550ec18c8cb4) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Add SPDX license headersakuster2020-06-179-0/+12
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 4609c3288be259fcc582fbe946ad6b411aa96e1a) Signed-off-by: Armin Kuster <akuster808@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>
* brief-yoctoprojectsqa: Add SPDX license headersakuster2020-06-174-0/+7
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 8bf1b566ddeaf6223ed065e9560cc096a18fe14d) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Add SPDX license headersakuster2020-06-174-0/+6
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 0aa081c3f1839833043e116db1729a9de342f72e) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Add SPDX license headersakuster2020-06-179-0/+11
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b2d60520431ef71ed2d1decf33605797995cb8f4) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-docs: Add SPDX headers in scripts and Makefileakuster2020-06-045-14/+16
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b87c540a1a6c0dce4c6010b89d9831442e0e7f70) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Update XXX_HOST_PACKAGES_ESSENTIAL to include mesa for other distrosRichard Purdie2020-06-041-3/+3
| | | | | | (From yocto-docs rev: e187f0f858bd4ed2eda10a5140cbc5ec222d7092) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Update OPENSUSE_HOST_PACKAGES_ESSENTIAL to include mesa-dri-develakuster2020-06-041-1/+1
| | | | | | | (From yocto-docs rev: 3003075b29bee696f226533e24ab7121508ca99b) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Update UBUNTU_HOST_PACKAGES_ESSENTIAL to match recent changesRichard Purdie2020-05-301-1/+1
| | | | | | (From yocto-docs rev: 7ed90c71caa6a23d2ef3b640a880069ca3ee3d24) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add PACKAGE_ADD_METADATA documentationMichael Ho2020-05-272-0/+92
| | | | | | | | | | | 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>
* ref-manual: document new unlisted-pkg-lics insane-skip qa checkQuentin Schulz2020-05-212-0/+31
| | | | | | | | | | | | | The new unlisted-pkg-lics INSANE_SKIP QA check was introduced and need proper documentation. This QA check makes sure all licenses listed for all packages built by a recipe are declared in the recipe LICENSE variable. (From yocto-docs rev: a50e0628f3d40f9103c9a6ecccde61ad6d7f21c6) Signed-off-by: Quentin Schulz <quentin.schulz@streamunlimited.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: delete long-unused comments in variable glossaryRobert P. J. Day2020-05-171-571/+0
| | | | | | | | | | As these comments have been around since 2015 and apparently unused, get rid of hundreds of them. (From yocto-docs rev: afec5770a22ac51c956e87567bf39e71064e9f04) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Remove long-dead PACKAGE_GROUP variableRobert P. J. Day2020-05-052-26/+2
| | | | | | | | | | This was, years ago, deprecated in favour of FEATURE_PACKAGES, so remove all references, other than the entry in the migration section. (From yocto-docs rev: 8e5469aadd31bc3de181848aae5733cd7835eefb) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: typo "SSTATE_MIRROR" -> "SSTATE_MIRRORS"Robert P. J. Day2020-05-051-1/+1
| | | | | | | (From yocto-docs rev: d694ff63f4aee0fff6eac0541413c1a36b3b02e2) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: IMAGE_TYPES, add tar.zst, delete elfRobert P. J. Day2020-05-051-1/+1
| | | | | | | | | | Update list of legal IMAGE_TYPES to match what's in image_types.bbclass. (From yocto-docs rev: 7706a240d6dbbace9a76b4b55427f91bd4afc6da) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix excessive command indentationRobert P. J. Day2020-05-051-2/+2
| | | | | | | (From yocto-docs rev: a95b49eef8f6bfde153677dda8021ffadf29d8f7) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updated patch for publishingMark Morton2020-04-241-2/+2
| | | | | | (From yocto-docs rev: ac352ad7f95db7eeacb53c2778caa31800bd7c26) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Added usrmerge to distro-features for Bug 13494mmorton2020-04-241-0/+6
| | | | | | (From yocto-docs rev: 049832ea4c13b01c31911ad0a6f3e170781db6cd) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correct "script" dirname to "scripts"Robert P. J. Day2020-04-241-2/+2
| | | | | | | (From yocto-docs rev: 43f042582675f89fcdf81c0cd2ac2602d4282cb3) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> 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>
* ref-manual: add migration section for 3.1Paul Eggleton2020-04-151-0/+201
| | | | | | | | | Migration information for the 3.1 release. (From yocto-docs rev: dda13761733c7f3fe672f45b8d06f6c3fcf8cb30) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.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>
* ref-manual: update PACKAGECONFIG glossary entryrpjday@crashcourse.ca2020-04-071-15/+25
| | | | | | | | | | | | | | Update the glossary entry for PACKAGECONFIG in two ways: 1) Explain the recent sixth argument, which identifies conflicting features for a given feature. 2) Use a different example, as the librsvg "croco" feature no longer works that way. (From yocto-docs rev: af9bf61a54c059e72c807ca8061a57d6fe74c5fa) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: fix obvious typo "ORHNAME"Robert P. J. Day2020-04-071-1/+1
| | | | | | | (From yocto-docs rev: d40485a7eecb8d54179b562f05b4d7b044bb03b2) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> 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>
* brief-yoctoprojectqs: buildtools changesTim Orling2020-04-061-4/+7
| | | | | | | | | | | | 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: ca6334c1653d5e2abfe77865391509a8cd516d88) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> 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>
* ref-manual: add install-buildtools and -extendedTim Orling2020-04-063-17/+120
| | | | | | | | | | | | | Add instructions to use 'install-buildtools' and 'buildtools-extended-tarball'. Add gcc 5.0 requirement and call out how to use above to prepare host development system. (From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.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-13 20:55:40 +0000