supervision - discussion about system services, daemon supervision, init, runlevel management, and tools such as s6 and runit
 help / color / mirror / Atom feed
From: "Laurent Bercot" <ska-supervision@skarnet.org>
To: supervision@list.skarnet.org
Subject: Re: s6-man-pages update
Date: Wed, 09 Sep 2020 08:19:23 +0000	[thread overview]
Message-ID: <emed10768e-2288-4eb5-80c0-30d9f72dc400@elzian> (raw)
In-Reply-To: <875z8nd1y5.fsf@ada>

>i've now completed the linting pass for the s6 man pages. The few remaining lint issues are either commented in the sources, or aren't actually an issue in this context.
>
>As per Laurent's request, i've also added a Makefile to facilitate installation; details in the repo README:
>
>https://github.com/flexibeast/s6-man-pages/

  Nice work! If you feel they're ready enough, I can add a link to them
in the s6 main page right away.

  Two comments:
  - The skarnet.org site is accessible in https, and is preferred.
Intra-site links have no default protocol, so they will link in http
if the client uses http, and in https if the client uses https; but
for absolute URLS, it would probably be best to write them as https.
  - You should list yourself in the AUTHORS section: I wrote the content,
but you wrote the man pages.


>* links to other skarnet.org documentation which does not yet have  man pages: s6-networking (s6-tcpserver-access, s6-tcpserver,  s6-tcpserver4, s6-tcpserver6), execline (execline and execlineb,  maybe others as well?), and skalibs stuff. For an example of a  page referring to s6-networking software,  cf. s6-connlimit.1.in. If that documentation was available as  man pages, these could just be made cross-references too.

  I don't want to be making suggestions on work I'm not going to do
myself and that I have no deep understanding of; but is there a way to
have an alternative in .Xr, as in "print as a cross-ref if the man
page exists, else print that text"? That would be ideal for placeholders
until the documentation for other packages is ported (which may very
well be "never").


>* links to non-skarnet.org sites, such as djb's site. These  certainly seem amenable to use of the footnoting style you  described above.

  Yes, I don't think it's reasonable to expect the whole Web to be
converted to man pages. ;)

--
  Laurent


  reply	other threads:[~2020-09-09  8:19 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-09  4:11 Alexis
2020-09-09  8:19 ` Laurent Bercot [this message]
2020-09-09 13:12   ` Alexis
2020-09-09 13:16   ` Érico Nogueira
2020-09-09 13:42     ` Laurent Bercot
2020-09-09 14:08       ` Alexis
2020-09-09 14:55         ` Laurent Bercot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=emed10768e-2288-4eb5-80c0-30d9f72dc400@elzian \
    --to=ska-supervision@skarnet.org \
    --cc=supervision@list.skarnet.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).