From: Kristaps Dzonsons <kristaps@bsd.lv>
To: tech@mdocml.bsd.lv
Cc: Ingo Schwarze <schwarze@usta.de>, jmc@openbsd.org
Subject: Re: Where to put mandoc roff documentation?
Date: Mon, 29 Nov 2010 18:01:16 +0100 [thread overview]
Message-ID: <4CF3DC5C.1040207@bsd.lv> (raw)
In-Reply-To: <20101128152330.GA23201@iris.usta.de>
> replying to myself in order to hold my promise:
>
> Ingo Schwarze wrote on Sat, Nov 27, 2010 at 10:46:31PM +0100:
>
>> Good, so i shall soon move roff.7 to share/man/man7
>
> Done.
>
>> and start polishing it such that we can install it
>> once we feel it is ripe.
>
> Do you think the patch below is sufficient to get it ready
> for installing it?
>
> Changes:
> - Change the one-line description to
> "roff language reference for mandoc"
> because what we have is really too presumptuous.
> - A bit more motivation in the DESCRIPTION.
> - Point to mandoc_char(7) below LANGUAGE SYNTAX.
> - Change MACRO SYNTAX to REQUEST SYNTAX.
> In roff, the little things after the initial dot that are built-in
> to the language have always been called "requests".
> In roff, "macros" are only those things defined by the user
> or by macro packages.
> In the same spirit, avoid the repetitive term "user-defined macro",
> but keep "user-defined string", as there are also predefined strings.
> - Describe request syntax more systematically.
> This also allows to remove the remark that arguments are
> delimited by whitespace at one or two other places.
> - Remove bogus backslashes from an `.if' example.
> No idea how they got there.
> I tested that the code works without the backslashes.
> - The braces supported by conditional requests are not macros,
> but escape sequences.
> - Make the documentation of the nS register a bit more precise.
> - Referring to doc.tmac makes no sense in roff(7).
> - Add SEE ALSO and HISTORY.
>
> [...]
>> Once we will be installing it, we can then start moving class 1
>> stuff there.
>
> That's still for the future.
Ingo and Jason,
I, for one, have no issues with these changes. Feel free to commit them
into BSD.lv.
Thanks!
Kristaps
--
To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2010-11-29 17:01 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20101127184503.GA27534@iris.usta.de>
[not found] ` <20101127211832.GA27550@kerhand.co.uk>
[not found] ` <20101127214631.GC27534@iris.usta.de>
2010-11-28 15:23 ` Ingo Schwarze
2010-11-29 17:01 ` Kristaps Dzonsons [this message]
2010-11-30 21:35 ` Ingo Schwarze
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=4CF3DC5C.1040207@bsd.lv \
--to=kristaps@bsd.lv \
--cc=jmc@openbsd.org \
--cc=schwarze@usta.de \
--cc=tech@mdocml.bsd.lv \
/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).