From: Alexis <flexibeast@gmail.com>
To: supervision@list.skarnet.org
Subject: Re: [request for review] Port of s6 documentation to mdoc(7)
Date: Tue, 01 Sep 2020 21:55:24 +1000 [thread overview]
Message-ID: <873641yamr.fsf@ada> (raw)
In-Reply-To: <em3d0fd716-f091-4f71-809a-4d2cb7f343ef@elzian>
Laurent Bercot <ska-supervision@skarnet.org> writes:
> I'm totally willing to use a HTML schema we can negotiate, to
> write
> future documentation in. What I don't want to do is:
> - Touch existing documentation, unless I have to rewrite the
> content of
> a page for some reason. Of course, if the conversion work is
> done by
> somebody else, I have no objection to upstreaming the new
> documents.
In terms of automating such a conversion, here are a few of the
things the automation would need to do:
* Determine whether some text is an environment
variable. Environment variables in the current HTML aren't
marked up. You might think that you could say "Well, if it's all
caps it's an env var", but that won't work, because will catch
things like SIGTERM and SO_REUSEADDR. You could special-case
'SIG*', but i'm not sure what could be done about things like
SO_REUSEADDR.
* Parse things like "s6-envuidgid [ -u | -g | -B ] [ -n ] [ -i |
-D uid:gid:gidlist ] account prog..." appropriately, so that
mdoc/roff using Op, Fl and Ar can be produced. The parsing will
also need keep track of the fact that further uses of "account"
in the mdoc/roff might need to be preceded by an Fl macro. Of
course, the word "account" is not necessarily referring to the
"account" argument, but also to the notion of an account in
general: in "s6-envuidgid looks account up by name in the
account database", the first "account" should be preceded by Fl,
but the second shouldn't. So this sort of thing would somehow
need to be handled as well.
Note that "-D uid:gid:gidlist" will require special handling, as
that seems to also need use of Ns to produce the correct output,
i.e. ".Op Fl i | D Ar uid Ns : Ns Ar gid Ns : Ns Ar
gidlist". Although, `mandoc -T lint` currently produces a warning
about the use of Ns there; if mdoc/roff experts have any
suggestions as to The Correct Way to do this, i'm all ears. :-)
* In accessrules.html, <tt> is used to indicate file paths,
function types, variable types and the accessrules library
itself; these cases will somehow need to be
distinguished. (There are currently places in s6-accessrules.7
where, in my first pass, i've used Ql when i should actually be
using Vt; that's one of the things i still need to fix.)
So my guess is that trying to automate a conversion will be much
more work than simply doing a conversion manually.
Alexis.
next prev parent reply other threads:[~2020-09-01 11:55 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-30 8:30 Alexis
2020-08-30 9:10 ` eric vidal
2020-08-31 6:56 ` Alexis
2020-08-30 10:01 ` Laurent Bercot
2020-08-31 7:01 ` Alexis
2020-08-31 11:04 ` Laurent Bercot
2020-08-31 14:29 ` Guillermo
2020-09-01 10:00 ` possible s6-rc redesign (was: [request for review] Port of s6 documentation to mdoc(7)) Laurent Bercot
2020-09-01 19:24 ` possible s6-rc redesign mobinmob
2020-09-01 22:16 ` Dudemanguy
2020-09-01 22:20 ` Laurent Bercot
2020-09-02 9:41 ` mobinmob
2020-09-02 12:14 ` Laurent Bercot
2020-09-01 23:14 ` possible s6-rc redesign (was: [request for review] Port of s6 documentation to mdoc(7)) Steve Litt
2020-08-31 16:08 ` [request for review] Port of s6 documentation to mdoc(7) J. Lewis Muir
2020-08-31 17:45 ` Jason Lenz
2020-08-31 19:14 ` J. Lewis Muir
2020-08-31 20:51 ` Laurent Bercot
2020-09-01 6:38 ` Casper Ti. Vector
2020-09-01 9:03 ` Alexis
2020-09-01 9:20 ` Casper Ti. Vector
2020-09-01 10:02 ` Alexis
2020-09-01 10:15 ` Casper Ti. Vector
2020-09-01 20:13 ` Steve Litt
2020-09-02 0:50 ` Alexis
[not found] ` <20200901063801.GA2158@caspervector>
2020-09-01 10:11 ` Laurent Bercot
2020-09-01 11:28 ` Casper Ti. Vector
2020-09-01 11:55 ` Alexis [this message]
2020-08-31 19:36 ` Laurent Bercot
2020-08-31 19:58 ` J. Lewis Muir
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=873641yamr.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).