Date: Sat, 24 Jan 2004 11:27:34 +0200 From: Diomidis Spinellis <dds@aueb.gr> To: Alfred Perlstein <alfred@FreeBSD.org> Cc: Dag-Erling Smorgrav <des@FreeBSD.org> Subject: Re: cvs commit: src/usr.bin/fetch fetch.1 Message-ID: <40123A86.3040102@aueb.gr> In-Reply-To: <20040123102933.GC53344@elvis.mu.org> References: <200401230450.i0N4omSZ049990@repoman.freebsd.org> <20040123080657.GC34542@FreeBSD.org.ua> <20040123102933.GC53344@elvis.mu.org>
next in thread | previous in thread | raw e-mail | index | archive | help
Alfred Perlstein wrote: > * Ruslan Ermilov <ru@FreeBSD.org> [040123 00:06] wrote: > >>On Thu, Jan 22, 2004 at 08:50:48PM -0800, Wes Peters wrote: >> >>>wes 2004/01/22 20:50:48 PST >>> >>> FreeBSD src repository >>> >>> Modified files: >>> usr.bin/fetch fetch.1 >>> Log: >>> Document fetch(1) environment variables in fetch(1) man page, instead of >>> taking lazy users on the arduous journey through SEE ALSO to fetch(3). >>> >>> PR: docs/61759 >>> Submitted by: Christian S.J. Peron <maneo@bsdpro.com> >>> >>> Revision Changes Path >>> 1.55 +108 -12 src/usr.bin/fetch/fetch.1 >>> >> >>Duplication is always bad. I also think that this change wasn't >>approved by the maintainer. > > For some reason I'd rather see fetch(3) xref fetch(1) for the > docco, it means that programmers may have to go through an extra > step rather than users. Let us not forget that the Unix manual pages provide reference material; they are not a user guide. They historically have been terse, to the point, and honest in admitting shortcomings (bugs). While a user might find it helpful to read the environment variable documentation in fetch(1), the correct thing to do in reference material is to document the variables where they are implemented, namely fetch(3), and provide a cross reference. Diomidis - dds@
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?40123A86.3040102>