From patchwork Mon May 25 08:41:18 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: ref-manual: add PACKAGE_ADD_METADATA documentation From: Michael Ho X-Patchwork-Id: 172823 Message-Id: <1590396078-370023-1-git-send-email-michael.ho@bmw.de> To: Cc: Michael Ho Date: Mon, 25 May 2020 10:41:18 +0200 From: Michael Ho 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. Signed-off-by: Michael Ho --- .../dev-manual/dev-manual-common-tasks.xml | 58 ++++++++++++++++++++++ documentation/ref-manual/ref-variables.xml | 34 +++++++++++++ 2 files changed, 92 insertions(+) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e9ce182..605d1ad 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -9057,6 +9057,9 @@ Creating node package manager (NPM) packages + + Adding custom metadata to packages + @@ -10761,6 +10764,61 @@ + +
+ Adding custom metadata to packages + + + The variable PACKAGE_ADD_METADATA + can be used to add additional metadata to packages. This is + reflected in the package control/spec file. To take the ipk + format for example, the CONTROL file stored inside would + contain the additional metadata as additional lines. + + + + The variable can be used in multiple ways, including using + suffixes to set it for a specific package type and/or package. + Note that the order of precedence is the same as this list: + + + PACKAGE_ADD_METADATA_<PKGTYPE>_<PN> + + + PACKAGE_ADD_METADATA_<PKGTYPE> + + + PACKAGE_ADD_METADATA_<PN> + + + PACKAGE_ADD_METADATA + + + <PKGTYPE> is a parameter and expected to be a + distinct name of specific package type: + + IPK for .ipk packages + DEB for .deb packages + RPM for .rpm packages + + <PN> is a parameter and expected to be a package name. + + + + The variable can contain multiple [one-line] metadata fields + separated by the literal sequence '\n'. The separator can be + redefined using the variable flag separator. + + + + The following is an example that adds two custom fields for + ipk packages: + + PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup: Applications/Spreadsheets" + + +
+
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 364cd09..657f6cf 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -9539,6 +9539,40 @@ + PACKAGE_ADD_METADATA + + PACKAGE_ADD_METADATA[doc] = "This variable defines additional metadata to add to packages." + + + + + This variable defines additional metdata to add to packages. + + + + You may find you need to inject additional metadata into + packages. This variable allows you to do that by setting + the injected data as the value. Multiple fields can be + added by splitting the content with the literal separator + "\n". + + + + The suffixes '_IPK', '_DEB', or '_RPM' can be applied to + the variable to do package type specific settings. It can + also be made package specific by using the package name as + a suffix. + + + + You can find out more about applying this variable in + the + "Adding custom metadata to packages" + section in the Yocto Project Development Tasks Manual. + + + + PACKAGE_ARCH PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages."