From owner-freebsd-current@FreeBSD.ORG Tue Feb 17 23:47:14 2004 Return-Path: Delivered-To: freebsd-current@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 608E216A4CE; Tue, 17 Feb 2004 23:47:14 -0800 (PST) Received: from telecom.net.et (ns2.telecom.net.et [213.55.64.38]) by mx1.FreeBSD.org (Postfix) with ESMTP id BFFA343D3F; Tue, 17 Feb 2004 23:47:04 -0800 (PST) (envelope-from mtm@identd.net) Received: from [213.55.66.192] (HELO pool-151-200-10-97.res.east.verizon.net) by telecom.net.et (CommuniGate Pro SMTP 3.4.8) with ESMTP-TLS id 36966755; Wed, 18 Feb 2004 10:41:04 +0300 Received: from mobile.acs-et.com (localhost [127.0.0.1]) ESMTP id i1I7kacg002289; Wed, 18 Feb 2004 10:46:40 +0300 (EAT) (envelope-from mtm@mobile.acs-et.com) Received: (from mtm@localhost) by mobile.acs-et.com (8.12.10/8.12.10/Submit) id i1I7kXJ6002281; Wed, 18 Feb 2004 10:46:33 +0300 (EAT) (envelope-from mtm) Date: Wed, 18 Feb 2004 10:46:24 +0300 From: Mike Makonnen To: Alfred Perlstein Message-ID: <20040218074624.GB1140@mobile.acs-et.com> References: <20040216210759.GB55055@elvis.mu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20040216210759.GB55055@elvis.mu.org> User-Agent: Mutt/1.4.1i X-Operating-System: FreeBSD/5.2-CURRENT (i386) cc: mtm@FreeBSD.org cc: current@FreeBSD.org Subject: Re: rc.d missing source comments. X-BeenThere: freebsd-current@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Discussions about the use of FreeBSD-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 18 Feb 2004 07:47:14 -0000 On Mon, Feb 16, 2004 at 01:07:59PM -0800, Alfred Perlstein wrote: > I just opened /etc/rc.d/nfslocking and had no clue as to what it does. > > There is not a single comment explaining the logic. > > Would it be possible for some amount of comments to be added? > > (honestly I've had an easier time tracking down what SYSV init > scripts do) > The rc.d scripts have a lot of stuff that is done automagically. You should read rc(8) and rc.subr(8). Those two man pages almost completely document the general rc.d mechanism. I say "almost" because some newer routines in /etc/rc.subr are not documented in the man page yet, and because some individual scripts that offer extra functionality (like rc.d/netif) are not documented yet. While there are some small things that should probably be documented in rc.d/nfslocking if you have read those two man pages it should be very easy to figure out. The main difference from other rc.d scripts is that it is used to start several daemons, instead of just one (I will comment that shortly). I don't mean to suggest that rc.d is as well documented as it ought to be. But, I do think it is well documented enough that anyone who has read the man pages should be able to understand the individual scripts. We do accept suggestions for improvement and we do try to document stuff as we go along, but this is, after all, a volunteer effort and we suffer from the same time and monetary (i.e. day job) constraints as everyone else in the project. Cheers. -- Mike Makonnen | GPG-KEY: http://www.identd.net/~mtm/mtm.asc mtm@identd.net | Fingerprint: AC7B 5672 2D11 F4D0 EBF8 5279 5359 2B82 7CD4 1F55 mtm@FreeBSD.Org| FreeBSD - Unleash the Daemon !