summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILESKhairul Rohaizzat Jamaluddin2020-09-291-1/+37
| | | | | | | | | | IMAGE_EFI_BOOT_FILES created to help differentiate files needed between bootimg-efi and bootimg-partition when creating the installer/.wic file. (From yocto-docs rev: 3430e56aaa8a528a062af534610dc60346347947) Signed-off-by: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix broken linksQuentin Schulz2020-09-224-5/+5
| | | | | | | | (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>
* ref-manual: examples: libxpm: add relative path to .incQuentin Schulz2020-09-171-1/+1
| | | | | | | | | | | | | In order to be able to build this example from anywhere, one needs to give the relative path from LAYERDIR to the .inc file. The path is the one for the inc file from openembedded-core. (From yocto-docs rev: cb92d16a6d638f39effa06a7334496f1b0c83b2a) 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>
* ref-manual: examples: hello-autotools: upgrade to 2.10Quentin Schulz2020-09-172-8/+9
| | | | | | | | | | | The 2.3 example was not working anymore so fixed it and upgraded all at once. (From yocto-docs rev: 12457c2410c4f0bfda254ceb4f5ef35127a7540f) 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-176-8/+8
| | | | | | | | (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: ref-manual/migration: Split each release into its own fileRichard Purdie2020-09-1718-5234/+5271
| | | | | | | | | This avoids the duplicate heading warnings at the slight expense of more directory clutter. (From yocto-docs rev: ef896d71836aa3bd6c926b36976a9c45d5f2ca15) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-tasks: Add populate_sdk_ext task definitionRichard Purdie2020-09-171-0/+11
| | | | | | (From yocto-docs rev: 0d4cc867c3faa0144ed5a2aaa2698a6f693a2404) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual links fixes and many other cleanups to importRichard Purdie2020-09-1716-3439/+4886
| | | | | | (From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-system-requirements: Improve formatting of the notes sections, ↵Richard Purdie2020-09-171-37/+35
| | | | | | | | merging them (From yocto-docs rev: 0b3360556bdce2a995b9931359f41cd4f6225aef) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual: fix heading for oe-init-build-envNicolas Dechesne2020-09-171-2/+2
| | | | | | | | | | | | | In DocBook this section name is set to &OE_INIT_FILE; variable. However using a substitution pattern in a heading in Sphinx does not seem to work well. Let's just set the script environment name here directly, without using a variable. We don't expect to change this name anyways, so a variable is not really needed. (From yocto-docs rev: e3347fa41888183c0818852fc07d1e0735406156) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix up terms related to kernel-fitimageNicolas Dechesne2020-09-171-14/+26
| | | | | | | | | | | | In this commit: 3aeca3b342e5 (ref-manual: Add documentation for kernel-fitimage), we added a few terms in the glossary, in the docbook xml file. However there were a few issues in the conversion to sphinx which needed to be fixed (missed terms, typo, and wrong placement). (From yocto-docs rev: 968efa8275e30350cead66613d01f491ee61be4d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> 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-68/+75
| | | | | | | | | 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-177-34/+31
| | | | | | | | | | 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-172-4/+4
| | | | | | | | | | | | | | | | | 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-178-25/+25
| | | | | | | | | | | | | | | | | 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-179-39/+33
| | | | | | | | | | | | | | 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: ref-manual: add figuresNicolas Dechesne2020-09-171-0/+4
| | | | | | | (From yocto-docs rev: 22a371230ab38df0558400a85829fb1e508b6e1d) 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-1710-98/+93
| | | | | | | | | | | 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-173-7/+7
| | | | | | | | | | 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: ref-manual: fix typoNicolas Dechesne2020-09-171-2/+2
| | | | | | | | | | The variable name is SSTATE_MIRROR, not STATE_MIRROR, and because of the typo, it was not caught by the Python regexp. (From yocto-docs rev: 7347f5343c4995c53da6b9a88a3912453def9669) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix internal linksNicolas Dechesne2020-09-1714-1383/+1383
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: use builtin glossary for the Terms sectionNicolas Dechesne2020-09-172-1126/+1152
| | | | | | | | | | | | | | | Using the builting glossary is well suited for the Yocto Project 'terms' section. Conveniently, all terms will also be added in the global index. While converting this to a glossary, also fixed up some content which was not properly converted by pandoc (such as codeblock sections, or references in between terms). (From yocto-docs rev: fce1d16eac1a92f3c6b7bfc74600197b5cb668a2) 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/+68
| | | | | | | (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-1716-0/+32
| | | | | | | | | | 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: 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-1717-0/+21085
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* 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-281-1/+1
| | | | | | | | | | | | | | | 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>
* 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>
* ref-manual: add PACKAGE_ADD_METADATA documentationMichael Ho2020-05-271-0/+34
| | | | | | | | | | | 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>
* 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>
* 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>
* 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>
* 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>
* ref-manual: fix debian-8 system reqsTim Orling2020-04-061-11/+21
| | | | | | | | | | | | | jessie-backports is no longer supported, so python3-git and pylint3 are not installable via apt-get (or at least not without disabling security checks by using archive.debian.org) Add note to use pip3 to install instead. (From yocto-docs rev: 19a02c5c6ef9a317c2339c2ec71200e51335e32f) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: bump tar and python min versionsTim Orling2020-04-061-2/+2
| | | | | | | | | | * tar min version is now 1.28 * python min version is now 3.5 (From yocto-docs rev: 96dfaee63f84c21fc2bf460ded642b853a5317cf) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: split CentOS-7 and CentOS-8 reqsTim Orling2020-04-061-8/+60
| | | | | | | | | | | | | | | CentOS-7 has different requirements than the much newer CentOS-8. Add a section for CentOS-8 and make the old section CentOS-7 specific. NOTE: at the time this was written, the 'fop' package is not yet available in epel-8. As a Fedora packager, that will change. (From yocto-docs rev: caf08811a23a29965ec915459019796a0c882d4d) 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-2/+2
| | | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 18:35:13 +0000