From owner-freebsd-doc Sat Mar 2 15: 1:52 2002 Delivered-To: freebsd-doc@freebsd.org Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5]) by hub.freebsd.org (Postfix) with ESMTP id 1646637B416 for ; Sat, 2 Mar 2002 15:01:46 -0800 (PST) Received: from hades.hell.gr (patr530-b140.otenet.gr [212.205.244.148]) by mailsrv.otenet.gr (8.12.2/8.12.2) with ESMTP id g22N1Zou011809; Sun, 3 Mar 2002 01:01:36 +0200 (EET) Received: (from charon@localhost) by hades.hell.gr (8.11.6/8.11.6) id g22N1XW23521; Sun, 3 Mar 2002 01:01:33 +0200 (EET) (envelope-from keramida@freebsd.org) Date: Sun, 3 Mar 2002 01:01:32 +0200 From: Giorgos Keramidas To: Michael Lucas Cc: Tom Rhodes , freebsd-doc@freebsd.org Subject: Re: docs/35098: [PATCH] Handbook NFS stuff Message-ID: <20020302230131.GA99866@hades.hell.gr> References: <200202262110.g1QLA2f07435@freefall.freebsd.org> <20020302152507.A83170@blackhelicopters.org> Mime-Version: 1.0 Content-Type: application/pgp; x-action=sign; format=text Content-Disposition: inline; filename="msg.pgp" In-Reply-To: <20020302152507.A83170@blackhelicopters.org> User-Agent: Mutt/1.3.27i Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 2002-03-02 15:25, Michael Lucas wrote: > Okay, I think I'm done ripping on this poor guys work. Anything left > for me to say is purely stylistic. Tom has been doing a lot of work, lately. Michael, you've also carefully checked what he posted, and usually have already commented already by the time I downloaded the thread. My compliments, guys :) You certainly make everyone envy you^W^W^H proud. > > There is no need for users to have unique home directories > - on every machine on your network. Once they have an established > - directory that is available via NFS it can be accessed from > - anywhere. > + on every network machine. Home directories could be setup on the > + NFS server and made available throughout the network. > I'd probably go for "There is no need for users to have separate ..." here. 'Unique' is almost exclusively used when a reference to a set of objects is made, and emphasis on their being different is needed. > > - Storage devices such as floppies and CDROM drives can be > - used by other machines on the network eliminating the need for > - extra hardware. > + Storage devices such as floppy disks, CDROM drives, and ZIP drives > + can be used by other machines on the network. This may reduce the number > + of removable media drives. Number of 'required' or 'necessary' media drives? Whose number of media drives? > + NFS consists of at least two main parts: a server > + and at least one client. The client remotely accesses the data that is stored > + on the server machine. In order for this to function properly a few > + processes have to be configured and running: Whitespace nit. If you use tab for initial line indentation, please use it consistently, before commiting this; since this replaces the entire paragraph, it doesn't count as a 'whitespace only change'. > + The portmapper daemon > + allows NFS clients to discover which port the NFS server > + is using. Whitespace nit. Since this is an entirely new , could we have it properly indented and wrapped too? (For some definition of 'properly' that fits the style of the rest of this document.) > + The client can also run a daemon, known as > + nfsiod. The nfsiod > + daemon services the requests from the NFS server. This > + is optional, and improves performance, but is not required for normal > + and correct operation. See the &man.nfsiod.8; man page for more information. s/man page/manual page/ This is not some doc-policy style of thing, but I tend to prefer one of these two forms: * The &blah; manual page. * You can find out by checking out &man.blah; how this is done. I'm not really that sure about this though. It's really up to you two to decide if you like one of these two any better. > + mountd runs automatically whenever the > + NFS server is enabled. Indentation needs fix0ring, and there's a missing . > nfs_client_enable="YES" > -nfs_client_flags="-n 4" > - > - Like nfsd, the tells > - nfsiod to start 4 copies of itself. > + Should we close on the first and 'last' line of content? nfs_client_enable="YES" > + > + The /etc/exports > ... > + that can be used in this file but only a few will be mentioned here. You can easily discover > + other options by reading over the &man.exports.5; manual page. > + Please indent a bit, wrap the replacement paragraph to some reasonable length, and make ... cuddle to the text within, at the beginning and end of it, like the rest of the text does: ... ... > + The following examples give an idea of how to export filesystems, > + although the settings may be different depending on > + your environment and network configuration. > + The following line exports /cdrom to > + three example machines that have the same domain name as the server I'm a little uncomfortable with two sentences that both start with 'The following'. The second could probably be rewritten as: For instance, to export /cdrom ... > + The following line exports /a so that two > + clients from different domains may access the filesystem. The > + flag allows the root > + user on the remote system to write data on the exported filesystem as That same tab vs. space thing for initial indentation, again :-/ Since there are many places where tabs and spaces have been mixed in indentation, I'll probably shuttup now. > + The &man.fstab.5; manual page lists all the available options. Wheeeee :) "The &foo; manual page." :) Thanks, thanks! > + Set several machines to share a CDROM or > + other media among them. This is cheaper and often > + more convenient. Than what? > + Several machines could have a common /usr/ports/distfiles wrap? [-- Finally --] Excellent work! I haven't used NFS in a while, and I am probably not the best guy to comment on technical parts of this, but it looks great. Very easy to follow, IMHO. My apologies, if commenting now is a bit late, and has you thinking things like 'Ya, right, Mr. Anal Retentiveness, where were you when we were writing this stuff?'. I seem to have a complete lack of organization in my time schedule these last weeks, and I keep forgetting TODO stuff. Cheers, Giorgos Keramidas FreeBSD Documentation Project keramida@{freebsd.org,ceid.upatras.gr} http://www.FreeBSD.org/docproj/ -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.6 (FreeBSD) iD8DBQE8gVnL1g+UGjGGA7YRAnn9AJ4g/baYxyLTAcvNbIrhY8oCfQM2vACfSOe8 PEySyVyLUJX6dhmufV3y7+c= =bzKC -----END PGP SIGNATURE----- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message