* [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation
@ 2017-06-11 19:23 Chris Mayo
2017-06-11 22:13 ` Mike Gilbert
2017-06-13 22:58 ` Michał Górny
0 siblings, 2 replies; 5+ messages in thread
From: Chris Mayo @ 2017-06-11 19:23 UTC (permalink / raw
To: gentoo-dev
Signed-off-by: Chris Mayo <aklhfex@gmail.com>
---
Nothing added, just suggesting how it could be made easier to understand.
Chris
eclass/systemd.eclass | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/eclass/systemd.eclass b/eclass/systemd.eclass
index 7e46e80119c..49f7480228b 100644
--- a/eclass/systemd.eclass
+++ b/eclass/systemd.eclass
@@ -178,12 +178,12 @@ systemd_newuserunit() {
}
# @FUNCTION: systemd_install_serviced
-# @USAGE: <conf-file> [<service.d>]
+# @USAGE: <conf-file> [<service>]
# @DESCRIPTION:
-# Install the file <conf-file> as service.d/00gentoo.conf template.
-# The <service.d> argument specifies the configured service name.
-# If not specified, the configuration file name will be used with .conf
-# suffix stripped (e.g. foo.service.conf -> foo.service).
+# Install <conf-file> as the template <service>.d/00gentoo.conf.
+# If <service> is not specified
+# <conf-file> with the .conf suffix stripped is used
+# (e.g. foo.service.conf -> foo.service.d/00gentoo.conf).
systemd_install_serviced() {
debug-print-function ${FUNCNAME} "${@}"
--
2.13.0
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation
2017-06-11 19:23 [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation Chris Mayo
@ 2017-06-11 22:13 ` Mike Gilbert
2017-06-13 22:58 ` Michał Górny
1 sibling, 0 replies; 5+ messages in thread
From: Mike Gilbert @ 2017-06-11 22:13 UTC (permalink / raw
To: Gentoo Dev
On Sun, Jun 11, 2017 at 3:23 PM, Chris Mayo <aklhfex@gmail.com> wrote:
> Signed-off-by: Chris Mayo <aklhfex@gmail.com>
Signed-off-by is not required for Gentoo contributions.
> ---
>
> Nothing added, just suggesting how it could be made easier to understand.
>
> Chris
The patch looks ok; I'll push it if there are no objections over the
next day or so.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation
2017-06-11 19:23 [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation Chris Mayo
2017-06-11 22:13 ` Mike Gilbert
@ 2017-06-13 22:58 ` Michał Górny
2017-06-14 2:52 ` Mike Gilbert
1 sibling, 1 reply; 5+ messages in thread
From: Michał Górny @ 2017-06-13 22:58 UTC (permalink / raw
To: gentoo-dev
[-- Attachment #1: Type: text/plain, Size: 1447 bytes --]
On nie, 2017-06-11 at 20:23 +0100, Chris Mayo wrote:
> Signed-off-by: Chris Mayo <aklhfex@gmail.com>
> ---
>
> Nothing added, just suggesting how it could be made easier to understand.
>
> Chris
>
> eclass/systemd.eclass | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/eclass/systemd.eclass b/eclass/systemd.eclass
> index 7e46e80119c..49f7480228b 100644
> --- a/eclass/systemd.eclass
> +++ b/eclass/systemd.eclass
> @@ -178,12 +178,12 @@ systemd_newuserunit() {
> }
>
> # @FUNCTION: systemd_install_serviced
> -# @USAGE: <conf-file> [<service.d>]
> +# @USAGE: <conf-file> [<service>]
> # @DESCRIPTION:
> -# Install the file <conf-file> as service.d/00gentoo.conf template.
> -# The <service.d> argument specifies the configured service name.
> -# If not specified, the configuration file name will be used with .conf
> -# suffix stripped (e.g. foo.service.conf -> foo.service).
> +# Install <conf-file> as the template <service>.d/00gentoo.conf.
> +# If <service> is not specified
> +# <conf-file> with the .conf suffix stripped is used
> +# (e.g. foo.service.conf -> foo.service.d/00gentoo.conf).
> systemd_install_serviced() {
> debug-print-function ${FUNCNAME} "${@}"
>
This is meritoriously wrong. The second argument is required to have
'.d' suffix, while your help text suggests that '.d' is appended
implicitly.
--
Best regards,
Michał Górny
[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 988 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation
2017-06-13 22:58 ` Michał Górny
@ 2017-06-14 2:52 ` Mike Gilbert
2017-06-14 7:42 ` Michał Górny
0 siblings, 1 reply; 5+ messages in thread
From: Mike Gilbert @ 2017-06-14 2:52 UTC (permalink / raw
To: Gentoo Dev
On Tue, Jun 13, 2017 at 6:58 PM, Michał Górny <mgorny@gentoo.org> wrote:
> On nie, 2017-06-11 at 20:23 +0100, Chris Mayo wrote:
>> Signed-off-by: Chris Mayo <aklhfex@gmail.com>
>> ---
>>
>> Nothing added, just suggesting how it could be made easier to understand.
>>
>> Chris
>>
>> eclass/systemd.eclass | 10 +++++-----
>> 1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> diff --git a/eclass/systemd.eclass b/eclass/systemd.eclass
>> index 7e46e80119c..49f7480228b 100644
>> --- a/eclass/systemd.eclass
>> +++ b/eclass/systemd.eclass
>> @@ -178,12 +178,12 @@ systemd_newuserunit() {
>> }
>>
>> # @FUNCTION: systemd_install_serviced
>> -# @USAGE: <conf-file> [<service.d>]
>> +# @USAGE: <conf-file> [<service>]
>> # @DESCRIPTION:
>> -# Install the file <conf-file> as service.d/00gentoo.conf template.
>> -# The <service.d> argument specifies the configured service name.
>> -# If not specified, the configuration file name will be used with .conf
>> -# suffix stripped (e.g. foo.service.conf -> foo.service).
>> +# Install <conf-file> as the template <service>.d/00gentoo.conf.
>> +# If <service> is not specified
>> +# <conf-file> with the .conf suffix stripped is used
>> +# (e.g. foo.service.conf -> foo.service.d/00gentoo.conf).
>> systemd_install_serviced() {
>> debug-print-function ${FUNCNAME} "${@}"
>>
>
> This is meritoriously wrong. The second argument is required to have
> '.d' suffix, while your help text suggests that '.d' is appended
> implicitly.
WTF are you talking about?
# avoid potentially common mistake
[[ ${service} == *.d ]] && die "Service must not have .d suffix"
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation
2017-06-14 2:52 ` Mike Gilbert
@ 2017-06-14 7:42 ` Michał Górny
0 siblings, 0 replies; 5+ messages in thread
From: Michał Górny @ 2017-06-14 7:42 UTC (permalink / raw
To: gentoo-dev
[-- Attachment #1: Type: text/plain, Size: 1915 bytes --]
On wto, 2017-06-13 at 22:52 -0400, Mike Gilbert wrote:
> On Tue, Jun 13, 2017 at 6:58 PM, Michał Górny <mgorny@gentoo.org> wrote:
> > On nie, 2017-06-11 at 20:23 +0100, Chris Mayo wrote:
> > > Signed-off-by: Chris Mayo <aklhfex@gmail.com>
> > > ---
> > >
> > > Nothing added, just suggesting how it could be made easier to understand.
> > >
> > > Chris
> > >
> > > eclass/systemd.eclass | 10 +++++-----
> > > 1 file changed, 5 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/eclass/systemd.eclass b/eclass/systemd.eclass
> > > index 7e46e80119c..49f7480228b 100644
> > > --- a/eclass/systemd.eclass
> > > +++ b/eclass/systemd.eclass
> > > @@ -178,12 +178,12 @@ systemd_newuserunit() {
> > > }
> > >
> > > # @FUNCTION: systemd_install_serviced
> > > -# @USAGE: <conf-file> [<service.d>]
> > > +# @USAGE: <conf-file> [<service>]
> > > # @DESCRIPTION:
> > > -# Install the file <conf-file> as service.d/00gentoo.conf template.
> > > -# The <service.d> argument specifies the configured service name.
> > > -# If not specified, the configuration file name will be used with .conf
> > > -# suffix stripped (e.g. foo.service.conf -> foo.service).
> > > +# Install <conf-file> as the template <service>.d/00gentoo.conf.
> > > +# If <service> is not specified
> > > +# <conf-file> with the .conf suffix stripped is used
> > > +# (e.g. foo.service.conf -> foo.service.d/00gentoo.conf).
> > > systemd_install_serviced() {
> > > debug-print-function ${FUNCNAME} "${@}"
> > >
> >
> > This is meritoriously wrong. The second argument is required to have
> > '.d' suffix, while your help text suggests that '.d' is appended
> > implicitly.
>
> WTF are you talking about?
>
> # avoid potentially common mistake
> [[ ${service} == *.d ]] && die "Service must not have .d suffix"
>
A thinko then. Nevermind.
--
Best regards,
Michał Górny
[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 988 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-06-14 7:42 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-06-11 19:23 [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation Chris Mayo
2017-06-11 22:13 ` Mike Gilbert
2017-06-13 22:58 ` Michał Górny
2017-06-14 2:52 ` Mike Gilbert
2017-06-14 7:42 ` Michał Górny
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox