summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/svg/releases.svg99
-rw-r--r--documentation/ref-manual/tasks.rst9
-rw-r--r--documentation/ref-manual/variables.rst33
3 files changed, 98 insertions, 43 deletions
diff --git a/documentation/ref-manual/svg/releases.svg b/documentation/ref-manual/svg/releases.svg
index 198d4632b1..036aa467cc 100644
--- a/documentation/ref-manual/svg/releases.svg
+++ b/documentation/ref-manual/svg/releases.svg
@@ -3,8 +3,8 @@
3 version="1.1" 3 version="1.1"
4 id="svg2" 4 id="svg2"
5 width="2040.0006" 5 width="2040.0006"
6 height="624.30518" 6 height="669.30511"
7 viewBox="0 0 2040.0006 624.30515" 7 viewBox="0 0 2040.0006 669.30509"
8 sodipodi:docname="releases.svg" 8 sodipodi:docname="releases.svg"
9 inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" 9 inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)"
10 xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" 10 xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
@@ -409,8 +409,8 @@
409 id="namedview4" 409 id="namedview4"
410 showgrid="true" 410 showgrid="true"
411 inkscape:zoom="1.4472045" 411 inkscape:zoom="1.4472045"
412 inkscape:cx="736.24703" 412 inkscape:cx="987.76641"
413 inkscape:cy="312.32629" 413 inkscape:cy="357.93145"
414 inkscape:window-x="1728" 414 inkscape:window-x="1728"
415 inkscape:window-y="0" 415 inkscape:window-y="0"
416 inkscape:window-maximized="1" 416 inkscape:window-maximized="1"
@@ -427,13 +427,13 @@
427 type="xygrid" 427 type="xygrid"
428 id="grid1257" 428 id="grid1257"
429 originx="-289.99936" 429 originx="-289.99936"
430 originy="325" /> 430 originy="369.99998" />
431 </sodipodi:namedview> 431 </sodipodi:namedview>
432 <g 432 <g
433 inkscape:groupmode="layer" 433 inkscape:groupmode="layer"
434 inkscape:label="Image" 434 inkscape:label="Image"
435 id="g10" 435 id="g10"
436 transform="translate(-289.99936,325.00004)"> 436 transform="translate(-289.99936,370.00003)">
437 <path 437 <path
438 style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" 438 style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
439 d="m 1080,220.00003 v -515.00007 0 0" 439 d="m 1080,220.00003 v -515.00007 0 0"
@@ -669,11 +669,11 @@
669 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" 669 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
670 id="tspan10317-2-9-1-4">4.2</tspan></text> 670 id="tspan10317-2-9-1-4">4.2</tspan></text>
671 <g 671 <g
672 id="g1379"> 672 id="g1258">
673 <rect 673 <rect
674 style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" 674 style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1"
675 id="rect917-0-0-4-4-9-4-5-38" 675 id="rect917-0-0-4-4-9-4-5-38"
676 width="140.00003" 676 width="120.00002"
677 height="45.000004" 677 height="45.000004"
678 x="1220" 678 x="1220"
679 y="-230.00005" 679 y="-230.00005"
@@ -696,53 +696,76 @@
696 id="tspan10317-2-9-1-4-6">4.3</tspan></text> 696 id="tspan10317-2-9-1-4-6">4.3</tspan></text>
697 </g> 697 </g>
698 <rect 698 <rect
699 style="opacity:0.75;fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" 699 style="opacity:0.75;fill:#241f31;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1"
700 id="rect917-0-0-4-4-9-4-5-3-9" 700 id="rect917-0-0-4-4-9-4-5-3-9-2"
701 width="979.99994" 701 width="140"
702 height="45.000004" 702 height="45.000004"
703 x="1320" 703 x="1440"
704 y="-285.00003" 704 y="-340.00003"
705 ry="2.2558987" /> 705 ry="2.2558987" />
706 <text 706 <text
707 xml:space="preserve" 707 xml:space="preserve"
708 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" 708 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
709 x="1373.233" 709 x="1487.233"
710 y="-265.32928" 710 y="-320.32928"
711 id="text1185-3-55-4-0-0-0-1-1-6"><tspan 711 id="text1185-3-55-4-0-0-0-1-1-6-4"><tspan
712 sodipodi:role="line" 712 sodipodi:role="line"
713 x="1373.233" 713 x="1487.233"
714 y="-265.32928" 714 y="-320.32928"
715 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" 715 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
716 id="tspan957-2-8-6-3-9-7-4-2">Scarthgap</tspan><tspan 716 id="tspan957-2-8-6-3-9-7-4-2-0">Styhead</tspan><tspan
717 sodipodi:role="line" 717 sodipodi:role="line"
718 x="1373.233" 718 x="1487.233"
719 y="-247.33261" 719 y="-302.33261"
720 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" 720 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
721 id="tspan10317-2-9-1-4-6-5">5.0</tspan></text> 721 id="tspan10317-2-9-1-4-6-5-6">5.1</tspan></text>
722 <rect 722 <g
723 id="g1591">
724 <rect
725 style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1"
726 id="rect917-0-0-4-4-9-9"
727 width="960.00012"
728 height="45.000004"
729 x="859.99994"
730 y="-64.999992"
731 ry="2.2558987" />
732 <text
733 xml:space="preserve"
734 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
735 x="928.49872"
736 y="-45.648258"
737 id="text1185-3-55-4-0-0-9"><tspan
738 sodipodi:role="line"
739 x="928.49872"
740 y="-45.648258"
741 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
742 id="tspan957-2-8-6-3-6">Kirkstone (LTS)</tspan><tspan
743 sodipodi:role="line"
744 x="928.49872"
745 y="-27.651579"
746 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
747 id="tspan10317-2-9-0">4.0</tspan></text>
748 </g>
749 <path
750 id="rect917-0-0-4-4-9-9-9"
723 style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" 751 style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1"
724 id="rect917-0-0-4-4-9-9" 752 d="m 1322.3015,-285.00003 c -1.2753,0 -2.302,1.00609 -2.302,2.25586 v 40.48828 c 0,1.24977 1.0267,2.25586 2.302,2.25586 h 975.0412 c 1.2754,0 2.302,-1.00609 2.302,-2.25586 v -40.48828 c 0,-1.24977 -1.0266,-2.25586 -2.302,-2.25586 z" />
725 width="960.00012"
726 height="45.000004"
727 x="859.99994"
728 y="-64.999992"
729 ry="2.2558987" />
730 <text 753 <text
731 xml:space="preserve" 754 xml:space="preserve"
732 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" 755 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
733 x="928.49872" 756 x="1390.4988"
734 y="-45.648258" 757 y="-265.64832"
735 id="text1185-3-55-4-0-0-9"><tspan 758 id="text1185-3-55-4-0-0-9-0"><tspan
736 sodipodi:role="line" 759 sodipodi:role="line"
737 x="928.49872" 760 x="1390.4988"
738 y="-45.648258" 761 y="-265.64832"
739 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" 762 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
740 id="tspan957-2-8-6-3-6">Kirkstone (LTS)</tspan><tspan 763 id="tspan957-2-8-6-3-6-8">Scarthgap (LTS)</tspan><tspan
741 sodipodi:role="line" 764 sodipodi:role="line"
742 x="928.49872" 765 x="1390.4988"
743 y="-27.651579" 766 y="-247.65164"
744 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" 767 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none"
745 id="tspan10317-2-9-0">4.0</tspan></text> 768 id="tspan10317-2-9-0-1">5.0</tspan></text>
746 <text 769 <text
747 xml:space="preserve" 770 xml:space="preserve"
748 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" 771 style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 2e4b23408d..df751d75a3 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -412,12 +412,11 @@ them. You can learn more by looking at the
412------------- 412-------------
413 413
414Unpacks the source code into a working directory pointed to by 414Unpacks the source code into a working directory pointed to by
415``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` 415``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify
416variable also plays a role in where unpacked source files ultimately 416this directory is through the :term:`S` and :term:`WORKDIR` variables.
417reside. For more information on how source files are unpacked, see the 417For more information on how source files are unpacked, see the
418":ref:`overview-manual/concepts:source fetching`" 418":ref:`overview-manual/concepts:source fetching`"
419section in the Yocto Project Overview and Concepts Manual and also see 419section in the Yocto Project Overview and Concepts Manual.
420the :term:`WORKDIR` and :term:`S` variable descriptions.
421 420
422Manually Called Tasks 421Manually Called Tasks
423===================== 422=====================
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 3f37f42f21..07b5b6f95c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5585,6 +5585,21 @@ system and gives an overview of their function and contents.
5585 5585
5586 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot" 5586 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot"
5587 5587
5588 :term:`NVDCVE_API_KEY`
5589 The NVD API key used to retrieve data from the CVE database when
5590 using :ref:`ref-classes-cve-check`.
5591
5592 By default, no API key is used, which results in larger delays between API
5593 requests and limits the number of queries to the public rate limits posted
5594 at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__.
5595
5596 NVD API keys can be requested through the
5597 `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__
5598 page. You can set this variable to the NVD API key in your ``local.conf`` file.
5599 Example::
5600
5601 NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3"
5602
5588 :term:`OBJCOPY` 5603 :term:`OBJCOPY`
5589 The minimal command and arguments to run ``objcopy``. 5604 The minimal command and arguments to run ``objcopy``.
5590 5605
@@ -6829,6 +6844,19 @@ system and gives an overview of their function and contents.
6829 explicitly if that will not match the package name (e.g. where the 6844 explicitly if that will not match the package name (e.g. where the
6830 package name has a prefix, underscores, uppercase letters etc.) 6845 package name has a prefix, underscores, uppercase letters etc.)
6831 6846
6847 :term:`PYPI_PACKAGE_EXT`
6848 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6849 file extension to use when fetching a package from `PyPI
6850 <https://pypi.org/>`__. Default is ``tar.gz``.
6851
6852 :term:`PYPI_SRC_URI`
6853 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6854 full `pythonhosted <https://files.pythonhosted.org/>`__ URI for
6855 fetching the package to be built. The default value is constructed
6856 based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and
6857 :term:`PV`. Most recipes will not need to set this variable unless
6858 they are building an unstable (i.e. development) version.
6859
6832 :term:`PYTHON_ABI` 6860 :term:`PYTHON_ABI`
6833 When used by recipes that inherit the :ref:`ref-classes-setuptools3` 6861 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
6834 class, denotes the Application Binary Interface (ABI) currently in use 6862 class, denotes the Application Binary Interface (ABI) currently in use
@@ -9670,6 +9698,11 @@ system and gives an overview of their function and contents.
9670 :ref:`ref-classes-insane` class and is only enabled if the 9698 :ref:`ref-classes-insane` class and is only enabled if the
9671 recipe inherits the :ref:`ref-classes-autotools` class. 9699 recipe inherits the :ref:`ref-classes-autotools` class.
9672 9700
9701 :term:`UNPACKDIR`
9702 This variable, used by the :ref:`ref-classes-base` class,
9703 specifies where fetches sources should be unpacked by the
9704 :ref:`ref-tasks-unpack` task.
9705
9673 :term:`UPDATERCPN` 9706 :term:`UPDATERCPN`
9674 For recipes inheriting the 9707 For recipes inheriting the
9675 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN` 9708 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`