Bug#999637: systemd: systemctl help foo.service doesn't work with file:/path/to/README.md

[Nicholas D Steeves]

reopen 999637
tag 999637 upstream
forwarded 999637 https://github.com/systemd/systemd/issues/21369
thanks

Hi Michael,

Michael Biebl <biebl at debian.org> writes:

> On 15.11.21 00:09, Michael Biebl wrote:
>> 
>> On 14.11.21 04:59, Nicholas D Steeves wrote:
>
>>>    Documentation="file:/usr/share/doc/foo/README.md"
>> 
>> Hmm, systemctl help says
>> "
>>         help PATTERN...|PID...
>>             Show manual pages for one or more units, if available.
>> "
>> 
>> You are not pointing Documentation= at a man page though but an 
>> arbitrary file. Try e.g. "systemctl help rsyslog"
>
> Here is the relevant code
> https://salsa.debian.org/systemd-team/systemd/-/blob/debian/master/src/systemctl/systemctl-show.c#L792
>
>>         STRV_FOREACH(p, i->documentation)
>>                 if (startswith(*p, "man:"))
>>                         show_man_page(*p + 4, false);
>>                 else
>>                         log_info("Can't show: %s", *p);
>
>
> Afaics, everything is working as documented. Thus closing the bug report.
>

Thank you for the reference, much appreciated!  So it seems that the
documentation at
https://www.freedesktop.org/software/systemd/man/systemd.unit.html is wrong.

> If you think, that systemctl help should handly arbitrary file:/ URLs, 
> please file this as a feature request upstream at
>
> https://github.com/systemd/systemd/issues/new
>

Done, and I've set the relevant tag and forwarded URL so that we'll
receive a notification if upstream is against it.

Kind regards,
Nicholas