diff mbox series

ref-manual: update DEV_PKG_DEPENDENCY in variables

Message ID 20230223103636.10170-1-fawzi.khaber@smile.fr
State New
Headers show
Series ref-manual: update DEV_PKG_DEPENDENCY in variables | expand

Commit Message

Fawzi KHABER Feb. 23, 2023, 10:36 a.m. UTC 
Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS unstead
of RDEPENDS for the -dev package on the main package, this change fix the
documentation the match the actual state

Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr>
Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr>
---
 documentation/ref-manual/variables.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Quentin Schulz Feb. 24, 2023, 10:14 a.m. UTC | #1 
Hi Fawzi,

On 2/23/23 11:36, Fawzi KHABER wrote:
> Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS unstead
> of RDEPENDS for the -dev package on the main package, this change fix the
> documentation the match the actual state
> 

This is somewhat misleading.

DEV_PKG_DEPENDENCY was introduced in 4.1 and started by being used as 
RDEPENDS but then migrated to RRECOMMENDS during the normal development 
phase of the 4.1 release (before the first release actually).

Why it was important to me was to understand if we needed to backport 
this to 4.1 release docs and maybe even earlier.

FWIW, the commit introducing the mechanism is:
73cf55cdde1f ("bitbake.conf/recipes: Introduce add DEV_PKG_DEPENDENCY to 
change RDEPENDS:${PN}-dev")
and migrating to RRECOMMENDS:
ddbd90a37c7e ("bitbake.conf: Change -dev RDEPENDS to RRECOMMENDS")
(in poky).

In any case, the suggested change is correct, so
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

@Michael, this is a candidate for langdale backport.

Thanks,
Quentin
Michael Opdenacker Feb. 24, 2023, 3:04 p.m. UTC | #2 
Fawzi, Quentin,

Thanks for the patch and review!

On 24.02.23 at 11:14, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Fawzi,
>
> On 2/23/23 11:36, Fawzi KHABER wrote:
>> Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS 
>> unstead
>> of RDEPENDS for the -dev package on the main package, this change fix 
>> the
>> documentation the match the actual state
>>
>
> This is somewhat misleading.
>
> DEV_PKG_DEPENDENCY was introduced in 4.1 and started by being used as 
> RDEPENDS but then migrated to RRECOMMENDS during the normal 
> development phase of the 4.1 release (before the first release actually).
>
> Why it was important to me was to understand if we needed to backport 
> this to 4.1 release docs and maybe even earlier.
>
> FWIW, the commit introducing the mechanism is:
> 73cf55cdde1f ("bitbake.conf/recipes: Introduce add DEV_PKG_DEPENDENCY 
> to change RDEPENDS:${PN}-dev")
> and migrating to RRECOMMENDS:
> ddbd90a37c7e ("bitbake.conf: Change -dev RDEPENDS to RRECOMMENDS")
> (in poky).
>
> In any case, the suggested change is correct, so
> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Thanks.
Merged into "master-next"

>
> @Michael, this is a candidate for langdale backport.


Sure, good to know. I will send a patch shortly.
Thanks
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 725f5c54c..1f777602e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2004,9 +2004,9 @@  system and gives an overview of their function and contents.
       variable.
 
    :term:`DEV_PKG_DEPENDENCY`
-      Provides an easy way for recipes to disable or adjust the runtime
-      dependency (:term:`RDEPENDS`) of the ``${PN}-dev`` package on the main
-      (``${PN}``) package, particularly where the main package may be empty.
+      Provides an easy way for recipes to disable or adjust the runtime recommendation
+      (:term:`RRECOMMENDS`) of the ``${PN}-dev`` package on the main
+      (``${PN}``) package.
 
    :term:`DISABLE_STATIC`
       Used in order to disable static linking by default (in order to save