Re: [gentoo-dev] [PATCH] systemd.eclass: Improve systemd_install_serviced documentation

[Mike Gilbert <floppym@gentoo.org>]

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"