diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 67 |
1 files changed, 63 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e9ce182a59..247f6abfd4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1,6 +1,7 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> | ||
4 | 5 | ||
5 | <chapter id='extendpoky'> | 6 | <chapter id='extendpoky'> |
6 | 7 | ||
@@ -3189,7 +3190,7 @@ | |||
3189 | building an image. | 3190 | building an image. |
3190 | </para></listitem> | 3191 | </para></listitem> |
3191 | <listitem><para> | 3192 | <listitem><para> |
3192 | <filename>virtual/mesa</filename>: | 3193 | <filename>virtual/libgbm</filename>: |
3193 | Provides <filename>gbm.pc</filename>. | 3194 | Provides <filename>gbm.pc</filename>. |
3194 | </para></listitem> | 3195 | </para></listitem> |
3195 | <listitem><para> | 3196 | <listitem><para> |
@@ -8383,7 +8384,7 @@ | |||
8383 | If you see the following error, you need to | 8384 | If you see the following error, you need to |
8384 | update or create a | 8385 | update or create a |
8385 | <filename>~/.mtoolsrc</filename> file and | 8386 | <filename>~/.mtoolsrc</filename> file and |
8386 | be sure to have the line “mtools_skip_check=1“ | 8387 | be sure to have the line "mtools_skip_check=1" |
8387 | in the file. | 8388 | in the file. |
8388 | Then, run the Wic command again: | 8389 | Then, run the Wic command again: |
8389 | <literallayout class='monospaced'> | 8390 | <literallayout class='monospaced'> |
@@ -9057,6 +9058,9 @@ | |||
9057 | <listitem><para> | 9058 | <listitem><para> |
9058 | <link linkend='creating-node-package-manager-npm-packages'>Creating node package manager (NPM) packages</link> | 9059 | <link linkend='creating-node-package-manager-npm-packages'>Creating node package manager (NPM) packages</link> |
9059 | </para></listitem> | 9060 | </para></listitem> |
9061 | <listitem><para> | ||
9062 | <link linkend='adding-custom-metadata-to-packages'>Adding custom metadata to packages</link> | ||
9063 | </para></listitem> | ||
9060 | </itemizedlist> | 9064 | </itemizedlist> |
9061 | </para> | 9065 | </para> |
9062 | 9066 | ||
@@ -9833,7 +9837,7 @@ | |||
9833 | <listitem><para> | 9837 | <listitem><para> |
9834 | Select the desired package format as follows: | 9838 | Select the desired package format as follows: |
9835 | <literallayout class='monospaced'> | 9839 | <literallayout class='monospaced'> |
9836 | PACKAGE_CLASSES ?= “package_<replaceable>packageformat</replaceable>” | 9840 | PACKAGE_CLASSES ?= "package_<replaceable>packageformat</replaceable>" |
9837 | </literallayout> | 9841 | </literallayout> |
9838 | where <replaceable>packageformat</replaceable> | 9842 | where <replaceable>packageformat</replaceable> |
9839 | can be "ipk", "rpm", "deb", or "tar" which are the | 9843 | can be "ipk", "rpm", "deb", or "tar" which are the |
@@ -10761,6 +10765,61 @@ | |||
10761 | </para> | 10765 | </para> |
10762 | </section> | 10766 | </section> |
10763 | </section> | 10767 | </section> |
10768 | |||
10769 | <section id='adding-custom-metadata-to-packages'> | ||
10770 | <title>Adding custom metadata to packages</title> | ||
10771 | |||
10772 | <para> | ||
10773 | The variable <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ADD_METADATA'><filename>PACKAGE_ADD_METADATA</filename></ulink> | ||
10774 | can be used to add additional metadata to packages. This is | ||
10775 | reflected in the package control/spec file. To take the ipk | ||
10776 | format for example, the CONTROL file stored inside would | ||
10777 | contain the additional metadata as additional lines. | ||
10778 | </para> | ||
10779 | |||
10780 | <para> | ||
10781 | The variable can be used in multiple ways, including using | ||
10782 | suffixes to set it for a specific package type and/or package. | ||
10783 | Note that the order of precedence is the same as this list: | ||
10784 | <itemizedlist> | ||
10785 | <listitem><para> | ||
10786 | <filename>PACKAGE_ADD_METADATA_<PKGTYPE>_<PN></filename> | ||
10787 | </para></listitem> | ||
10788 | <listitem><para> | ||
10789 | <filename>PACKAGE_ADD_METADATA_<PKGTYPE></filename> | ||
10790 | </para></listitem> | ||
10791 | <listitem><para> | ||
10792 | <filename>PACKAGE_ADD_METADATA_<PN></filename> | ||
10793 | </para></listitem> | ||
10794 | <listitem><para> | ||
10795 | <filename>PACKAGE_ADD_METADATA</filename> | ||
10796 | </para></listitem> | ||
10797 | </itemizedlist> | ||
10798 | <PKGTYPE> is a parameter and expected to be a | ||
10799 | distinct name of specific package type: | ||
10800 | <itemizedlist> | ||
10801 | <listitem><para>IPK for .ipk packages</para></listitem> | ||
10802 | <listitem><para>DEB for .deb packages</para></listitem> | ||
10803 | <listitem><para>RPM for .rpm packages</para></listitem> | ||
10804 | </itemizedlist> | ||
10805 | <PN> is a parameter and expected to be a package name. | ||
10806 | </para> | ||
10807 | |||
10808 | <para> | ||
10809 | The variable can contain multiple [one-line] metadata fields | ||
10810 | separated by the literal sequence '\n'. The separator can be | ||
10811 | redefined using the variable flag <filename>separator</filename>. | ||
10812 | </para> | ||
10813 | |||
10814 | <para> | ||
10815 | The following is an example that adds two custom fields for | ||
10816 | ipk packages: | ||
10817 | <literallayout class='monospaced'> | ||
10818 | PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup: Applications/Spreadsheets" | ||
10819 | </literallayout> | ||
10820 | </para> | ||
10821 | </section> | ||
10822 | |||
10764 | </section> | 10823 | </section> |
10765 | 10824 | ||
10766 | <section id='efficiently-fetching-source-files-during-a-build'> | 10825 | <section id='efficiently-fetching-source-files-during-a-build'> |
@@ -14134,7 +14193,7 @@ | |||
14134 | <filename>local.conf</filename> file or in an image | 14193 | <filename>local.conf</filename> file or in an image |
14135 | recipe: | 14194 | recipe: |
14136 | <literallayout class='monospaced'> | 14195 | <literallayout class='monospaced'> |
14137 | IMAGE_INSTALL_append = “ gdbserver" | 14196 | IMAGE_INSTALL_append = " gdbserver" |
14138 | </literallayout> | 14197 | </literallayout> |
14139 | The change makes sure the <filename>gdbserver</filename> | 14198 | The change makes sure the <filename>gdbserver</filename> |
14140 | package is included. | 14199 | package is included. |