9front - general discussion about 9front
 help / color / mirror / Atom feed
From: sl@stanleylieber.com
To: 9front@9front.org
Subject: Re: [9front] 9front man pages
Date: Fri, 08 Mar 2024 19:40:55 -0500	[thread overview]
Message-ID: <F32D06D85703A4F40215B49A72066DE2@gaff.inri.net> (raw)
In-Reply-To: <E841C88429B559D28FC250CD34B41D09@eigenstate.org>

some questions:

- why are the man pages the way they are
- which ones are new to 9front

some answers:

- one of the aims of the original authors was to keep the
man pages short, preferrably to one page, if possible.
- we've imported or added a lot of new stuff, many of the
man pages that appeared alongside that new stuff either
disregarded or never promised to adhere to the intentions
of plan 9's original authors.

some suggestions:

- i agree, evaluating one page at a time is the only way
forward.  read and edit for content, but only if necessary.
- i prefer the "table of flags" approach, myself, but have been
rebuffed on this point in the past.  there is no consensus, so it is
what it is.  i like ori's suggestion of creating a special
macro, but then that implies a massive effort to update
every single man page that features flags, and some mechanism
for enforcing its use in future (otherwise the effort would be
kind of useless), both of which seem unlikely to happen.
- "read the source" as an alternative to documenting flags
seems to obviate the need for man pages at all, which is
quite a bit more radical than editing the man pages that
already exist.  probably the source and the man pages should
be arranged to compliment each other, since neither can
really replace the other's intended function.
- uriel's suggestion way back when to dive into editing man
pages as a way of contributing when you don't know how to do
anything else was more geared towards spellcheck and grammar,
if i understood him correctly.  early in my plan 9 career i
stumbled over pretty much this same debate.  there was even
an argument to omit some debug flags i unearthed because if
we documented them then we would have to maintain them (or so the
argument went).

sl

  reply	other threads:[~2024-03-09  0:43 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-08  4:47 eso
2024-03-08  5:07 ` Jacob Moody
2024-03-08  5:28   ` Roberto E. Vargas Caballero
2024-03-08  9:01     ` qwx
2024-03-08 11:30       ` hiro
2024-03-08 11:34         ` hiro
2024-03-08 11:35           ` hiro
2024-03-08 16:01           ` eso
2024-03-08 16:24             ` qwx
2024-03-08  5:23 ` ori
2024-03-08 17:40   ` Lyndon Nerenberg (VE7TFX/VE6BBM)
2024-03-08 18:30     ` hiro
2024-03-08 23:20       ` umbraticus
2024-03-08 23:50         ` ori
2024-03-09  0:40           ` sl [this message]
2024-03-09  1:08             ` hiro
2024-03-09  1:36               ` Stanley Lieber
2024-03-09 11:01                 ` sirjofri
2024-03-10 19:16                   ` Lyndon Nerenberg (VE7TFX/VE6BBM)
2024-03-10 21:05                     ` sirjofri
2024-03-10 21:11                     ` hiro

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=F32D06D85703A4F40215B49A72066DE2@gaff.inri.net \
    --to=sl@stanleylieber.com \
    --cc=9front@9front.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).