supervision - discussion about system services, daemon supervision, init, runlevel management, and tools such as s6 and runit
 help / color / mirror / Atom feed
From: Alexis <flexibeast@gmail.com>
To: supervision@list.skarnet.org
Subject: Re: s6-man-pages update
Date: Wed, 09 Sep 2020 23:12:59 +1000	[thread overview]
Message-ID: <87tuw7ayas.fsf@ada> (raw)
In-Reply-To: <emed10768e-2288-4eb5-80c0-30d9f72dc400@elzian>


Laurent Bercot <ska-supervision@skarnet.org> writes:

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

Mm, thanks, but i think i'd prefer to wait until i've handled the 
link issue. :-)

>  - 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

Sure, will do.

>  - You should list yourself in the AUTHORS section: I wrote the 
>  content,
> but you wrote the man pages.

Okay, i'll mention myself as the porter.

>  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"?

No, Xr only takes a manual name and section number as arguments.

> That would be ideal for placeholders
> until the documentation for other packages is ported (which may 
> very
> well be "never").

Well, i'm willing to port the s6-networking and execline docs, 
unless the longer-term plan is to convert them to e.g. scdoc, 
since (having now looked into it) it's a very weak markup format 
that can't represent most of the semantic markup i'd be adding, 
including cross-references. No point doing work that is just going 
to be removed. :-)

That said, for now i'll follow the footnote-style approach you 
suggested more generally, with numbered links to s6-networking and 
execline programs in the SEE ALSO section, and the appropriate 
number being mentioned inline. If/when the relevant man pages 
become available, conversion to use of Xr can be automated.

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

*laugh* Indeed!


Alexis.

  reply	other threads:[~2020-09-09 13:13 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
2020-09-09 13:12   ` Alexis [this message]
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=87tuw7ayas.fsf@ada \
    --to=flexibeast@gmail.com \
    --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).