[1/2] manuals: SYSTEMD_SERVICE allows multiple services

Message ID 20220603163521.146659-1-ptsneves@gmail.com
State Accepted, archived
Delegated to: Armin Kuster
Headers show
Series [1/2] manuals: SYSTEMD_SERVICE allows multiple services | expand

Commit Message

Paulo Neves June 3, 2022, 4:35 p.m. UTC
State that SYSTEMD_SERVICE allows for multiple space
separated systemd services
---
 documentation/ref-manual/variables.rst | 2 ++
 1 file changed, 2 insertions(+)

Comments

Michael Opdenacker June 6, 2022, 4:35 p.m. UTC | #1
Hi Paulo

Thanks for the patches!

On 6/3/22 18:35, Paulo Neves wrote:
> State that SYSTEMD_SERVICE allows for multiple space
> separated systemd services
> ---
>  documentation/ref-manual/variables.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 367b4674e..ed52c3508 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7656,6 +7656,8 @@ system and gives an overview of their function and contents.
>        When inheriting the :ref:`systemd <ref-classes-systemd>` class,
>        this variable specifies the systemd service name for a package.
>  
> +      Multiple services can be specified with each one separated by a space.


I'd propose a slightly simpler sentence:
"... can be specified, each one separated ..."

Would you mind sending the patch again to docs@lists.yoctoproject.org,
and this time with "Signed-off-by" information (from "git commit -s"),
please?
I was going to accept your patch directly, but this is required.

Thanks in advance
Michael.
Michael Opdenacker June 6, 2022, 4:47 p.m. UTC | #2
Hi again Paulo and developers,

On 6/3/22 18:35, Paulo Neves wrote:
> State that SYSTEMD_SERVICE allows for multiple space
> separated systemd services
> ---
>  documentation/ref-manual/variables.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 367b4674e..ed52c3508 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7656,6 +7656,8 @@ system and gives an overview of their function and contents.
>        When inheriting the :ref:`systemd <ref-classes-systemd>` class,
>        this variable specifies the systemd service name for a package.
>  
> +      Multiple services can be specified with each one separated by a space.


Wouldn't it make more sense to call the variable "SYSTEMD_SERVICES" instead?
We could add a new variable and deprecate the old one.

What do you think? Would it be worth the trouble?

Cheers
Michael.
Paulo Neves June 7, 2022, 8:33 a.m. UTC | #3
I think so, given we have a deprecation mechanism enforced in code.
The confusion definitely came up, and this is why a documentation 
clarification was needed.

Paulo Neves

On 6/6/22 18:47, Michael Opdenacker wrote:
> Hi again Paulo and developers,
>
> On 6/3/22 18:35, Paulo Neves wrote:
>> State that SYSTEMD_SERVICE allows for multiple space
>> separated systemd services
>> ---
>>   documentation/ref-manual/variables.rst | 2 ++
>>   1 file changed, 2 insertions(+)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index 367b4674e..ed52c3508 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -7656,6 +7656,8 @@ system and gives an overview of their function and contents.
>>         When inheriting the :ref:`systemd <ref-classes-systemd>` class,
>>         this variable specifies the systemd service name for a package.
>>   
>> +      Multiple services can be specified with each one separated by a space.
>
> Wouldn't it make more sense to call the variable "SYSTEMD_SERVICES" instead?
> We could add a new variable and deprecate the old one.
>
> What do you think? Would it be worth the trouble?
>
> Cheers
> Michael.
>
Michael Opdenacker June 7, 2022, 9:30 a.m. UTC | #4
Hi Paulo

On 6/7/22 10:33, Paulo Neves wrote:
> I think so, given we have a deprecation mechanism enforced in code.
> The confusion definitely came up, and this is why a documentation
> clarification was needed.


That's done on the documentation side. Then, what about proposing a
patch to openembedded-core to introduce a new SYSTEMD_SERVICES variable
and deprecate SYSTEMD_SERVICE?
Cheers
Michael.

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 367b4674e..ed52c3508 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7656,6 +7656,8 @@  system and gives an overview of their function and contents.
       When inheriting the :ref:`systemd <ref-classes-systemd>` class,
       this variable specifies the systemd service name for a package.
 
+      Multiple services can be specified with each one separated by a space.
+
       When you specify this file in your recipe, use a package name
       override to indicate the package to which the value applies. Here is
       an example from the connman recipe::