Re: [request for review] Port of s6 documentation to mdoc(7)

From: Laurent Bercot <ska-supervision_at_skarnet.org>
Date: Mon, 31 Aug 2020 11:04:04 +0000

>Certainly. i'll do that once i've completed a linting pass.

  Excellent.


>Sure, i'd be happy to reflect any changes.

  And the people rejoiced and celebrated, because they would soon,
finally, have s6 man pages.


>Ah, okay - thanks for the heads-up.

  Also a heads-up for people who are currently using s6-rc, including
in elaborate distribution-integrated setups: don't worry, no matter
how things shape up, the current version of s6-rc is going to be
supported for a looooong time.


>Now that i think about it some more, maybe i could simply put the link in parentheses? For example, with:
>
> a CDB file cdbfile then exits 0.
>
>where "CDB file" is a link to the relevant Wikipedia page, the mdoc would produce output like:
>
> a CDB file (http://en.wikipedia.org/wiki/Cdb_(software)) cdbfile then exits 0.

  I think that solely depends on the number of such links. If there are
just a few, it's fine. If there are a lot of links in a page, it would
make reading pretty unwieldy. Because I think there are a few pages with
too many links, maybe it would be best, for consistency, to just use
footnotes?

< a CDB file[1] cdbfile then exits 0.
<
< (...)
<
< SEE ALSO
<
< [1]: http://en.wikipedia.org/wiki/Cdb_(software)

  Maybe mdoc even has a mechanism for footnotes? I don't know.


>*nod* i'll try to put together an email with the relevant information, and start hanging out on #s6. :-) i'm usually on Freenode, in #voidlinux in particular, but not necessarily active at the same time as others - i'm in Melbourne.au.

  We don't care much about timezones. You can find people to interact
with
at almost any time of the day, and if not, we generally answer as soon
as
we're online. ;)

--
  Laurent
Received on Mon Aug 31 2020 - 11:04:04 UTC

This archive was generated by hypermail 2.3.0 : Sun May 09 2021 - 19:44:19 UTC