diff mbox series

[1/1] package/wireguard-linux-compat: add missing comment about kernel dependency

Message ID 20211016084136.2475297-1-fontaine.fabrice@gmail.com
State Accepted
Headers show
Series [1/1] package/wireguard-linux-compat: add missing comment about kernel dependency | expand

Commit Message

Fabrice Fontaine Oct. 16, 2021, 8:41 a.m. UTC
Add a comment when kernel is not enabled (missing since the addition of
the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
---
 package/wireguard-linux-compat/Config.in | 3 +++
 1 file changed, 3 insertions(+)

Comments

Peter Korsgaard Oct. 16, 2021, 8:46 a.m. UTC | #1
>>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:

 > Add a comment when kernel is not enabled (missing since the addition of
 > the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)

 > Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
 > ---
 >  package/wireguard-linux-compat/Config.in | 3 +++
 >  1 file changed, 3 insertions(+)

 > diff --git a/package/wireguard-linux-compat/Config.in b/package/wireguard-linux-compat/Config.in
 > index 5a323a35e5..4e8e95bdc3 100644
 > --- a/package/wireguard-linux-compat/Config.in
 > +++ b/package/wireguard-linux-compat/Config.in
 > @@ -21,6 +21,9 @@ config BR2_PACKAGE_WIREGUARD_LINUX_COMPAT
 
 >  	  https://www.wireguard.com
 
 > +comment "wireguard-linux-compat needs a Linux kernel to be built"
 > +	depends on !BR2_LINUX_KERNEL

Is this really a sensible comment? I would imagine that needing a Linux
kernel is an obvious requirement for a kernel driver?


 > +
 >  comment "wireguard-linux-compat needs a toolchain w/ headers >= 3.10"
 >  	depends on BR2_LINUX_KERNEL
 >  	depends on !BR2_TOOLCHAIN_HEADERS_AT_LEAST_3_10
 > -- 
 > 2.33.0
Fabrice Fontaine Oct. 16, 2021, 8:51 a.m. UTC | #2
Le sam. 16 oct. 2021 à 10:46, Peter Korsgaard <peter@korsgaard.com> a écrit :
>
> >>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:
>
>  > Add a comment when kernel is not enabled (missing since the addition of
>  > the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)
>
>  > Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
>  > ---
>  >  package/wireguard-linux-compat/Config.in | 3 +++
>  >  1 file changed, 3 insertions(+)
>
>  > diff --git a/package/wireguard-linux-compat/Config.in b/package/wireguard-linux-compat/Config.in
>  > index 5a323a35e5..4e8e95bdc3 100644
>  > --- a/package/wireguard-linux-compat/Config.in
>  > +++ b/package/wireguard-linux-compat/Config.in
>  > @@ -21,6 +21,9 @@ config BR2_PACKAGE_WIREGUARD_LINUX_COMPAT
>
>  >        https://www.wireguard.com
>
>  > +comment "wireguard-linux-compat needs a Linux kernel to be built"
>  > +    depends on !BR2_LINUX_KERNEL
>
> Is this really a sensible comment? I would imagine that needing a Linux
> kernel is an obvious requirement for a kernel driver?
We have this comment for other drivers such as dahdi-linux and xr819-xradio.
So I think we should be consistent in all packages.
>
>
>  > +
>  >  comment "wireguard-linux-compat needs a toolchain w/ headers >= 3.10"
>  >      depends on BR2_LINUX_KERNEL
>  >      depends on !BR2_TOOLCHAIN_HEADERS_AT_LEAST_3_10
>  > --
>  > 2.33.0
>
>
> --
> Bye, Peter Korsgaard
Best Regards,

Fabrice
Peter Korsgaard Oct. 16, 2021, 8:58 a.m. UTC | #3
>>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:

 > Le sam. 16 oct. 2021 à 10:46, Peter Korsgaard <peter@korsgaard.com> a écrit :
 >> 
 >> >>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:
 >> 
 >> > Add a comment when kernel is not enabled (missing since the addition of
 >> > the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)
 >> 
 >> > Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
 >> > ---
 >> >  package/wireguard-linux-compat/Config.in | 3 +++
 >> >  1 file changed, 3 insertions(+)
 >> 
 >> > diff --git a/package/wireguard-linux-compat/Config.in
 >> > b/package/wireguard-linux-compat/Config.in
 >> > index 5a323a35e5..4e8e95bdc3 100644
 >> > --- a/package/wireguard-linux-compat/Config.in
 >> > +++ b/package/wireguard-linux-compat/Config.in
 >> > @@ -21,6 +21,9 @@ config BR2_PACKAGE_WIREGUARD_LINUX_COMPAT
 >> 
 >> >        https://www.wireguard.com
 >> 
 >> > +comment "wireguard-linux-compat needs a Linux kernel to be built"
 >> > +    depends on !BR2_LINUX_KERNEL
 >> 
 >> Is this really a sensible comment? I would imagine that needing a Linux
 >> kernel is an obvious requirement for a kernel driver?
 > We have this comment for other drivers such as dahdi-linux and xr819-xradio.
 > So I think we should be consistent in all packages.

Ok, I'll take care of it.
Yann E. MORIN Oct. 16, 2021, 12:10 p.m. UTC | #4
Peter, All,

On 2021-10-16 10:46 +0200, Peter Korsgaard spake thusly:
> >>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:
>  > Add a comment when kernel is not enabled (missing since the addition of
>  > the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)
[--SNIP--]
> Is this really a sensible comment? I would imagine that needing a Linux
> kernel is an obvious requirement for a kernel driver?

Remember that some people build their kernel outside of Buildroot, or
do not build it at all, so they may not think of this as "an obvious
requirement"...

I agree with Fabrice: we have that comment in quite some places, and
this is explicitly documented in our manual:

    18.2.5. Dependencies on a Linux kernel built by buildroot

    Some packages need a Linux kernel to be built by buildroot. These
    are typically kernel modules or firmware. A comment should be added
    in the Config.in file to express this dependency, similar to
    dependencies on toolchain options. The general format is:

        foo needs a Linux kernel to be built

Regards,
Yann E. MORIN.
Yann E. MORIN Oct. 17, 2021, 7:50 a.m. UTC | #5
Fabrice, All,

On 2021-10-16 10:41 +0200, Fabrice Fontaine spake thusly:
> Add a comment when kernel is not enabled (missing since the addition of
> the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)
> 
> Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  package/wireguard-linux-compat/Config.in | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/package/wireguard-linux-compat/Config.in b/package/wireguard-linux-compat/Config.in
> index 5a323a35e5..4e8e95bdc3 100644
> --- a/package/wireguard-linux-compat/Config.in
> +++ b/package/wireguard-linux-compat/Config.in
> @@ -21,6 +21,9 @@ config BR2_PACKAGE_WIREGUARD_LINUX_COMPAT
>  
>  	  https://www.wireguard.com
>  
> +comment "wireguard-linux-compat needs a Linux kernel to be built"
> +	depends on !BR2_LINUX_KERNEL
> +
>  comment "wireguard-linux-compat needs a toolchain w/ headers >= 3.10"
>  	depends on BR2_LINUX_KERNEL
>  	depends on !BR2_TOOLCHAIN_HEADERS_AT_LEAST_3_10
> -- 
> 2.33.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot
Peter Korsgaard Oct. 22, 2021, 6:42 p.m. UTC | #6
>>>>> "Fabrice" == Fabrice Fontaine <fontaine.fabrice@gmail.com> writes:

 > Add a comment when kernel is not enabled (missing since the addition of
 > the package in commit de591c5c3a93a40d049a32bd79c30cc66daf5fb2)

 > Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Committed to 2021.02.x and 2021.08.x, thanks.
diff mbox series

Patch

diff --git a/package/wireguard-linux-compat/Config.in b/package/wireguard-linux-compat/Config.in
index 5a323a35e5..4e8e95bdc3 100644
--- a/package/wireguard-linux-compat/Config.in
+++ b/package/wireguard-linux-compat/Config.in
@@ -21,6 +21,9 @@  config BR2_PACKAGE_WIREGUARD_LINUX_COMPAT
 
 	  https://www.wireguard.com
 
+comment "wireguard-linux-compat needs a Linux kernel to be built"
+	depends on !BR2_LINUX_KERNEL
+
 comment "wireguard-linux-compat needs a toolchain w/ headers >= 3.10"
 	depends on BR2_LINUX_KERNEL
 	depends on !BR2_TOOLCHAIN_HEADERS_AT_LEAST_3_10