Skip to contentSkip to conversation

ref-manual: Document the fifth argument to PACKAGECONFIG

PATCH In review Peter Kjellerstedt 2 participants 4 messages Dec 13, 2018 – Dec 14, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 ref-manual: Document the fifth argument to PACKAGECONFIG

Support for adding runtime recommendations (RRECOMMENDS) using PACKAGECONFIG was introduced in Rocko.

---
 documentation/ref-manual/ref-variables.xml | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
documentation/ref-manual/ref-variables.xml +8 -4
index 58c5418d16..7dc3a3f79a 100644
@@ -10333,9 +10333,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     Here is the basic block structure:
                     <literallayout class='monospaced'>
      PACKAGECONFIG ??= "f1 f2 f3 ..."
-     PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1"
-     PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2"
-     PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3"
+     PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1"
+     PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2"
+     PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3"
                     </literallayout>
                 </para>
 
@@ -10344,7 +10344,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     variable itself specifies a space-separated list of the
                     features to enable.
                     Following the features, you can determine the behavior of
-                    each feature by providing up to four order-dependent
+                    each feature by providing up to five order-dependent
                     arguments, which are separated by commas.
                     You can omit any argument you like but must retain the
                     separating commas.
@@ -10370,6 +10370,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                             (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
                             that should be added if the feature is enabled.
                             </para></listitem>
+                        <listitem><para>Additional runtime recommendations
+                            (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>)
+                            that should be added if the feature is enabled.
+                            </para></listitem>
                     </orderedlist>
                 </para>
 
Signature · 1 line
2.12.0
#1 lore raw

PATCH 2/2 ref-manual: Add missing whitespace around "=" in a few code examples

---
 documentation/ref-manual/ref-variables.xml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
documentation/ref-manual/ref-variables.xml +5 -5
index 7dc3a3f79a..730737226e 100644
@@ -7655,9 +7655,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <literallayout class='monospaced'>
      KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
      KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
-     KERNEL_FEATURES_append_qemuall=" cfg/virtio.scc"
-     KERNEL_FEATURES_append_qemux86=" cfg/sound.scc cfg/paravirt_kvm.scc"
-     KERNEL_FEATURES_append_qemux86-64=" cfg/sound.scc"
+     KERNEL_FEATURES_append_qemuall = " cfg/virtio.scc"
+     KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
+     KERNEL_FEATURES_append_qemux86-64 = " cfg/sound.scc"
                     </literallayout></para>
             </glossdef>
         </glossentry>
@@ -10422,7 +10422,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                             <filename>PACKAGECONFIG</filename>.
                             You can either completely override the variable:
                             <literallayout class='monospaced'>
-     PACKAGECONFIG="f4 f5"
+     PACKAGECONFIG = "f4 f5"
                             </literallayout>
                             Or, you can just append the variable:
                             <literallayout class='monospaced'>
@@ -10436,7 +10436,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                             As with append files previously described,
                             you can either completely override the variable:
                             <literallayout class='monospaced'>
-     PACKAGECONFIG_pn-<replaceable>recipename</replaceable>="f4 f5"
+     PACKAGECONFIG_pn-<replaceable>recipename</replaceable> = "f4 f5"
                             </literallayout>
                             Or, you can just amend the variable:
                             <literallayout class='monospaced'>
Signature · 1 line
2.12.0
#2 lore raw

Re: [PATCH 2/2] ref-manual: Add missing whitespace around "=" in a few code examples

Peter,

Thank you for the patch in the ref-manual. I applied the patch (
https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=0d22771c64d082bf86f5efd85ac9aaeb1c7f3093
)

You can see the changes in the upcoming version of the ref-manual. I will back port as needed too.
http://www.yoctoproject.org/docs/2.7/ref-manual/ref-manual.html.

Scott

Quoted 52 lines · Peter Kjellerstedt
---
 documentation/ref-manual/ref-variables.xml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
documentation/ref-manual/ref-variables.xml +0 -0
index 7dc3a3f79a..730737226e 100644
@@ -7655,9 +7655,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR =

"${INC_PR}.3"
<literallayout class='monospaced'>
KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc
features/taskstats/taskstats.scc"

      KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
documentation/ref-manual/ref-variables.xml +2 -3
-     KERNEL_FEATURES_append_qemuall=" cfg/virtio.scc"
-     KERNEL_FEATURES_append_qemux86=" cfg/sound.scc cfg/paravirt_kvm.scc"
-     KERNEL_FEATURES_append_qemux86-64=" cfg/sound.scc"
+     KERNEL_FEATURES_append_qemuall = " cfg/virtio.scc"
+     KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc

cfg/paravirt_kvm.scc"

documentation/ref-manual/ref-variables.xml +1 -0
+     KERNEL_FEATURES_append_qemux86-64 = " cfg/sound.scc"
                     </literallayout></para>
             </glossdef>
         </glossentry>
@@ -10422,7 +10422,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR

= "${INC_PR}.3"
<filename>PACKAGECONFIG</filename>. You can either completely override the
variable:
<literallayout class='monospaced'>

documentation/ref-manual/ref-variables.xml +1 -1
-     PACKAGECONFIG="f4 f5"
+     PACKAGECONFIG = "f4 f5"
                             </literallayout>
                             Or, you can just append the variable:
                             <literallayout class='monospaced'>
@@ -10436,7 +10436,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR

= "${INC_PR}.3"
As with append files previously described, you can either completely override the
variable:
<literallayout class='monospaced'>

documentation/ref-manual/ref-variables.xml +1 -2
-     PACKAGECONFIG_pn-<replaceable>recipename</replaceable>="f4 f5"
+     PACKAGECONFIG_pn-<replaceable>recipename</replaceable> = "f4 f5"
                             </literallayout>
                             Or, you can just amend the variable:
                             <literallayout class='monospaced'>
--

2.12.0

#3 lore raw
In reply to Peter Kjellerstedt

Peter,

Thanks for the patch. See
https://yoctoproject.org/docs/2.7/ref-manual/ref-manual.html#var-PACKAGECONFIG
for the changes.

Commit:
https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=adb17e3172c829de77d2664c91f7cf4b22c9e5f0

Scott

Quoted 62 lines · Peter Kjellerstedt

Support for adding runtime recommendations (RRECOMMENDS) using PACKAGECONFIG was introduced in Rocko.

---
 documentation/ref-manual/ref-variables.xml | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
documentation/ref-manual/ref-variables.xml +0 -0
index 58c5418d16..7dc3a3f79a 100644
@@ -10333,9 +10333,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR

= "${INC_PR}.3"
Here is the basic block structure:
<literallayout class='monospaced'>
PACKAGECONFIG ??= "f1 f2 f3 ..."

documentation/ref-manual/ref-variables.xml +1 -3
-     PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1"
-     PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2"
-     PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3"
+     PACKAGECONFIG[f1] =

"--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1"
+ PACKAGECONFIG[f2] =
"--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2"
+ PACKAGECONFIG[f3] =
"--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3"

                     </literallayout>
                 </para>
documentation/ref-manual/ref-variables.xml +0 -0
@@ -10344,7 +10344,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR

= "${INC_PR}.3"
variable itself specifies a space-separated list of
the
features to enable.
Following the features, you can determine the
behavior of

documentation/ref-manual/ref-variables.xml +1 -1
-                    each feature by providing up to four order-dependent
+                    each feature by providing up to five order-dependent
                     arguments, which are separated by commas.
                     You can omit any argument you like but must retain the
                     separating commas.
@@ -10370,6 +10370,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR

= "${INC_PR}.3"

                             (<link
linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
                             that should be added if the feature is
enabled.
                             </para></listitem>
documentation/ref-manual/ref-variables.xml +2 -0
+                        <listitem><para>Additional runtime recommendations
+                            (<link

linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>)
+ that should be added if the feature is
enabled.
+ </para></listitem>

                     </orderedlist>
                 </para>

--
2.12.0