Your message dated Thu, 18 Nov 2021 21:10:47 +0100
with message-id <[email protected]>
and subject line Re: Bug#999637: systemd: systemctl help foo.service doesn't
work with file:/path/to/README.md
has caused the Debian Bug report #999637,
regarding systemd: systemctl help foo.service doesn't work with
file:/path/to/README.md
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)
--
999637: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=999637
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: systemd
Version: 249.6-1
Severity: normal
Hi,
Apologies for not reporting from a sid system. It affects systemd in
buster and bullseye as well, but I'm not sure if the version of
systemd in those version is new enough to support this type of
documentation. Steps to reproduce:
1. Install a testing system, including the standard system tools task
2. Upgrade to sid
3. Run "systemctl help foo" for a service file that uses the following
under the [Unit] section:
Documentation="file:/usr/share/doc/foo/README.md"
4. Result: STDERR "Can't show: file:/usr/share/doc/foo/README.md".
Return code of 0!? That's a separate bug, I think.
This is of course also the case with the README.md.gz that are almost
always used on Debian systems. I tested the uncompressed case in case
systemctl didn't have the ability to read compressed file.
I'm not sure where this functionality is broken. Could it be that
it's not enabled in the build? Could it be systemd needs to call a
pager, but our systemd hasn't been configured to use
/etc/alternatives/pager? This is all speculation, but my suspicion is
that it's actually upstream bug.
Regards,
Nicholas
--- End Message ---
--- Begin Message ---
On Sun, 14 Nov 2021 18:36:59 -0500 Nicholas D Steeves <[email protected]>
wrote:
> reopen 999637
> tag 999637 upstream
> forwarded 999637 https://github.com/systemd/systemd/issues/21369
> thanks
>
> Hi Michael,
>
> Michael Biebl <[email protected]> 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.
I reread the documentation and systemd.unit doesn't say anything about
support for "systemctl help". On the other hand, the systemctl man page is
pretty clear that help is only supported for man pages.
So I'd say the documentation is consistent and correct.
> > 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.
It appears upstream has rejected that feature request, and I can understand
why. Opening arbitray files is icky.
I don't think there remains anything on the downstream side to fix, so
closing.
Regards,
Michael
signature.asc
Description: This is a digitally signed message part
--- End Message ---
