Bug#964383: Issues in init-system-helpers man pages

[Helge Kreutzmann]

Hello Michael,
On Mon, Jul 06, 2020 at 04:18:22PM +0200, Michael Biebl wrote:
> Am 06.07.20 um 15:41 schrieb Helge Kreutzmann:
> > I'm now reporting the errors for your project. If future reports
> > should use another channel, please let me know.
> 
> Ideally such a change request is submitted via salsa as merge request.

As stated in my introduction, this is not (easily) possible, sorry. 

> This makes it much easier to comment on the individual changes.

I can send each change individually, some other projects (like
man-pages itself) request this. Do you want this in future reports (if
any)?

> https://salsa.debian.org/debian/init-system-helpers/
> 
> > Man page: deb-systemd-invoke.1p
> > Issue: Groff code broken?
> > 
> > "\\&B<deb-systemd-invoke> start|stop|restart I<unitÂ\\ file>Â\\ ..."
> 
> Can't really comment on that one. The resulting man page looks fine to me?
> That man pages is generated via pod2man, could this be a toolchain issue?

Probably.

> > --
> > Man page: deb-systemd-invoke.1p
> > Issue: 206 → 2006?
> > 
> > "Jan 206"
> 
> 
> I can't find any reference to "Jan 206" in the deb-systemd-invoke man
> page. Can you point the source location?
> Did you by chance confuse that with the service(8) man page which was
> fixed just recently:
> https://salsa.debian.org/debian/init-system-helpers/-/commit/f1b835dcb2d6198addfab045676351d70d2930e9

Yes, my fault, it was service(8). 

> > --
> > Man page: deb-systemd-invoke.1p
> > Issue: s/it to/to/
> > 
> > "The I<SCRIPT> parameter specifies a System V init script, located in B</etc/"
> > "init.d/>I<SCRIPT>.  The supported values of I<COMMAND> depend on the invoked "
> > "script, B<service> passes I<COMMAND> and I<OPTIONS> it to the init script "
> > "unmodified.  All scripts should support at least the B<start> and B<stop> "
> > "commands.  As a special case, if I<COMMAND> is B<--full-restart>, the script "
> > "is run twice, first with the B<stop> command, then with the B<start> command."
> 
> Can't find that paragraph either

Sorry, this is also in service.8

> > --
> > Man page: update-rc.d.8
> > Issue: insserv(8) → B<insserv>(8)
> > 
> > "update-rc.d requires dependency and runlevel information to be provided in "
> > "the init.d script LSB comment header of all init.d scripts.  See the "
> > "insserv(8) manual page for details about the LSB header format."
> > --
> > Man page: update-rc.d.8
> > Issue: update-rc.d → B<update-rc.d>
> > 
> > "When invoked with the I<remove> option, update-rc.d removes any links in the "
> > "B</etc/rc>I<runlevel>B<\\&.d> directories to the script B</etc/init.d/"
> > ">I<name>\\&.  The script must have been deleted already.  If the script is "
> > "still present then B<update-rc.d> aborts with an error message."
> 
> Those are generated via rst2man. I suposse wrapping them in `` `` would
> suffice?

I don't know rst2man, so I cannot answer this question.

Thanks for your ultra fast response and maintenance.

Greetings

         Helge

-- 
      Dr. Helge Kreutzmann                     debian at helgefjell.de
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/pkg-systemd-maintainers/attachments/20200706/19c13df0/attachment.sig>