The Unix Heritage Society mailing list
 help / color / mirror / Atom feed
From: Larry McVoy <lm@mcvoy.com>
To: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: TUHS main list <tuhs@tuhs.org>
Subject: [TUHS] Re: On Bloat and the Idea of Small Specialized Tools
Date: Sat, 18 May 2024 11:18:25 -0700	[thread overview]
Message-ID: <20240518181825.GT9216@mcvoy.com> (raw)
In-Reply-To: <CAKH6PiXaYGEUmVFRX99eM6s3+nTJrbVvkuBRa-Awhhd69xzJrg@mail.gmail.com>

On Sat, May 18, 2024 at 02:07:38PM -0400, Douglas McIlroy wrote:
> I just revisited this ironic echo of Mies van der Rohe's aphorism, "Less is
> more".
>        % less --help | wc
>       298
> Last time I looked, the line count was about 220. Bloat is self-catalyzing.
> 
> What prompted me to look was another disheartening discovery. The "small
> special tool" Gnu diff has a 95-page manual!  And it doesn't cover the
> option I was looking up (-h). To be fair, the manual includes related
> programs like diff3(1), sdiff(1) and patch(1), but the original manual for
> each fit on one page.

Normally I agree with Doug but on documentation, the less is more leaves me
cold.  It's fine when it is V7 cat that had maybe an option or two.  GNU
diff is a complex beast and it needs lots of docs.

Personally, I like it when man pages have a few usage examples, the BitKeeper
docs are like that.  But I'm ok with a terse man page with a SEE ALSO that
points to a user guide.

Docs should be helpful.
-- 
---
Larry McVoy           Retired to fishing          http://www.mcvoy.com/lm/boat

  parent reply	other threads:[~2024-05-18 18:18 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-18 18:07 Douglas McIlroy
2024-05-18 18:13 ` Brantley Coile
2024-05-18 18:18 ` Larry McVoy [this message]
2024-05-18 18:52   ` Clem Cole
2024-05-18 19:19     ` Luther Johnson
2024-05-18 20:12       ` segaloco via TUHS
2024-05-18 19:32     ` Stuff Received
2024-05-18 18:22 ` Ralph Corderoy
2024-05-19  8:58   ` [TUHS] The 'usage: ...' message. (Was: On Bloat...) Ralph Corderoy
2024-05-18 18:31 ` [TUHS] Re: On Bloat and the Idea of Small Specialized Tools Peter Weinberger (温博格) via TUHS
2024-05-18 20:33 ` Steffen Nurpmeso
2024-05-19  8:39   ` Marc Rochkind
2024-05-20  6:07     ` Adam Thornton
2024-05-20 15:43       ` [TUHS] Documentation (was On Bloat and the Idea of Small Specialized Tools) Paul Winalski
2024-05-20 16:37         ` [TUHS] " Andrew Hume
2024-05-20 18:38         ` Yeechang Lee
2024-05-20 19:27           ` Phil Budne

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=20240518181825.GT9216@mcvoy.com \
    --to=lm@mcvoy.com \
    --cc=douglas.mcilroy@dartmouth.edu \
    --cc=tuhs@tuhs.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).