ref-manual: Add missing/remove extraneous quotes
PATCH 1/2 ref-manual: Add missing/remove extraneous quotes
--- documentation/ref-manual/migration.xml | 4 ++-- documentation/ref-manual/ref-variables.xml | 20 +++++++++----------- 2 files changed, 11 insertions(+), 13 deletions(-)
documentation/ref-manual/migration.xml +2 -2
@@ -2110,7 +2110,7 @@ such as the following: <literallayout class='monospaced'> inherit bluetooth - PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)} + PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}" PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4" PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5" </literallayout>
@@ -3624,7 +3624,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. image types, this part of the kernel image base name as been removed leaving only the following: <literallayout class='monospaced'> - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME} + KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" </literallayout> If you have recipes or classes that use <filename>KERNEL_IMAGE_BASE_NAME</filename> directly, you might
documentation/ref-manual/ref-variables.xml +9 -11
@@ -367,7 +367,7 @@ <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm> <info> - ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." + ASSUME_SHLIBS[doc] = "Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." </info> <glossdef> <para role="glossdeffirst">
@@ -1423,7 +1423,7 @@ Use the following format to export the variable to the BitBake environment: <literallayout class='monospaced'> - export BBSERVER=localhost:$port" + export BBSERVER=localhost:$port </literallayout> </para>
@@ -3786,7 +3786,7 @@ It is not intended to be user-configurable. It is best to just reference the variable to see which distro features are being backfilled for all distro configurations. - See the <link linkend='ref-features-backfill'>Feature Backfilling</link> section for + See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for more information. </para> </glossdef>
@@ -11054,7 +11054,7 @@ <glossentry id='var-PN'><glossterm>PN</glossterm> <info> - PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. + PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package." </info> <glossdef> <para role="glossdeffirst">
@@ -13383,8 +13383,7 @@ <glossentry id='var-SKIP_FILEDEPS'><glossterm>SKIP_FILEDEPS</glossterm> <info> - SKIP_FILEDEPS[doc] = "Enables you to remove all files from - the "Provides" section of an RPM package." + SKIP_FILEDEPS[doc] = "Enables you to remove all files from the 'Provides' section of an RPM package." </info> <glossdef> <para role="glossdeffirst">
@@ -15331,7 +15330,7 @@ <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> <info> - TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc', 'musl' or "newlib." + TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc', 'musl' or 'newlib'." </info> <glossdef> <para role="glossdeffirst">
@@ -16473,7 +16472,7 @@ Appends a string to the name of the local version of the U-Boot image. For example, assuming the version of the U-Boot image - built was "2013.10, the full version string reported by + built was "2013.10", the full version string reported by U-Boot would be "2013.10-yocto" given the following statement: <literallayout class='monospaced'>
@@ -17108,7 +17107,7 @@ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" section in the Yocto Project Development Tasks Manual. For details on the kickstart file format, see the - "<link linkend='ref-kickstart'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link> + "<link linkend='ref-kickstart'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link>" Chapter. </para> </glossdef>
@@ -17178,8 +17177,7 @@ <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm> <info> - XSERVER[doc] = "Specifies the packages that should be installed - to provide an X server and drivers for the current machine." + XSERVER[doc] = "Specifies the packages that should be installed to provide an X server and drivers for the current machine." </info> <glossdef> <para role="glossdeffirst">
Signature · 1 line
2.21.0
PATCH 2/2 ref-manual: Update the documentation for USERADD_ERROR_DYNAMIC
* Update USERADD_ERROR_DYNAMIC[doc] and the first paragraph to match the definition in meta/conf/documentation.conf.
* Add a note explaining the differences in behavior when setting USERADD_ERROR_DYNAMIC to "warn" and "error" respectively.
[YOCTO #12932]
--- documentation/ref-manual/ref-variables.xml | 33 ++++++++++++++++------ 1 file changed, 25 insertions(+), 8 deletions(-)
documentation/ref-manual/ref-variables.xml +25 -8
@@ -16770,18 +16770,21 @@ <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm> <info> - USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files. If set to 'warn', a warning will be issued instead." + USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in any of the files listed in USERADD_UID_TABLES and USERADD_GID_TABLES. If set to 'warn', a warning will be issued instead." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "error", forces the OpenEmbedded build system to - produce an error if the user identification - (<filename>uid</filename>) and group identification - (<filename>gid</filename>) values are not defined - in <filename>files/passwd</filename> - and <filename>files/group</filename> files. - If set to "warn", a warning will be issued instead. + + If set to <filename>error</filename>, forces the + OpenEmbedded build system to produce an error if the user + identification (<filename>uid</filename>) and group + identification (<filename>gid</filename>) values are not + defined in any of the files listed + in <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link> + and <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>. If + set to <filename>warn</filename>, a warning will be issued + instead. </para> <para>
@@ -16808,6 +16811,20 @@ <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> variables. </para> + + <note> + There is a difference in behavior between + setting <filename>USERADD_ERROR_DYNAMIC</filename> + to <filename>error</filename> and setting it + to <filename>warn</filename>. When it is set + to <filename>warn</filename>, the build system will report a + warning for every undefined <filename>uid</filename> and + <filename>gid</filename> in any recipe. But when it is set + to <filename>error</filename>, it will only report errors + for recipes that are actually built. This saves you from + having to add static IDs for recipes that you know will + never be built. + </note> </glossdef> </glossentry>
Signature · 1 line
2.21.0
A message that is not in the archive (sent off-list or not yet received): [email protected]
Re: [yocto] [PATCH 2/2] ref-manual: Update the documentation for USERADD_ERROR_DYNAMIC
*ping*
//Peter
Quoted 102 lines
-----Original Message-----
From: [email protected] <[email protected]> On Behalf Of Peter Kjellerstedt
Sent: den 11 december 2019 18:12
To: [email protected]
Cc: Scott Rifenbark <[email protected]>
Subject: [yocto] [PATCH 2/2] ref-manual: Update the documentation forUSERADD_ERROR_DYNAMIC* Update USERADD_ERROR_DYNAMIC[doc] and the first paragraph to match the definition in
meta/conf/documentation.conf.
* Add a note explaining the differences in behavior when settingUSERADD_ERROR_DYNAMICto "warn" and "error" respectively.[YOCTO #12932]
Signed-off-by Peter Kjellerstedt <[email protected]>--- documentation/ref-manual/ref-variables.xml | 33 ++++++++++++++++------ 1 file changed, 25 insertions(+), 8 deletions(-)documentation/ref-manual/ref-variables.xml +0
-0@@ -16770,18 +16770,21 @@ <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm>
<info>- USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces
the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files. If set to 'warn', a warning will be issued instead."
+ USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces
the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in any of the files listed inUSERADD_UID_TABLESandUSERADD_GID_TABLES. If set to 'warn', a warning will be issued instead."</info> <glossdef> <para role="glossdeffirst"><!-- <para role="glossdeffirst"><imagedata
fileref="figures/define-generic.png" /> -->
- If set to "error", forces the OpenEmbedded build
system todocumentation/ref-manual/ref-variables.xml +3
-6- produce an error if the user identification - (<filename>uid</filename>) and group identification - (<filename>gid</filename>) values are not defined - in <filename>files/passwd</filename> - and <filename>files/group</filename> files. - If set to "warn", a warning will be issued instead. + + If set to <filename>error</filename>, forces the + OpenEmbedded build system to produce an error if theuser
documentation/ref-manual/ref-variables.xml +2
-0+ identification (<filename>uid</filename>) and group + identification (<filename>gid</filename>) values arenot
documentation/ref-manual/ref-variables.xml +2
-0+ defined in any of the files listed + in <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>
+ and <link linkend='var-
USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>. If
+ set to <filename>warn</filename>, a warning will be
issueddocumentation/ref-manual/ref-variables.xml +1
-0+ instead. </para> <para>@@ -16808,6 +16811,20 @@ <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
variables. </para>documentation/ref-manual/ref-variables.xml +7
-0+ + <note> + There is a difference in behavior between + setting <filename>USERADD_ERROR_DYNAMIC</filename> + to <filename>error</filename> and setting it + to <filename>warn</filename>. When it is set + to <filename>warn</filename>, the build system willreport a
+ warning for every undefined <filename>uid</filename>
and
+ <filename>gid</filename> in any recipe. But when it
is set
+ to <filename>error</filename>, it will only report
errors
+ for recipes that are actually built. This saves you
from
+ having to add static IDs for recipes that you know
willdocumentation/ref-manual/ref-variables.xml +2
-1+ never be built. + </note> </glossdef> </glossentry> --2.21.0