From owner-cvs-src@FreeBSD.ORG Fri Jun 2 00:25:01 2006 Return-Path: X-Original-To: cvs-src@freebsd.org Delivered-To: cvs-src@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 7C56B16A66A; Fri, 2 Jun 2006 00:25:01 +0000 (UTC) (envelope-from grog@lemis.com) Received: from ext-gw.lemis.com (ext-gw.lemis.com [150.101.14.10]) by mx1.FreeBSD.org (Postfix) with ESMTP id B479C43D45; Fri, 2 Jun 2006 00:25:00 +0000 (GMT) (envelope-from grog@lemis.com) Received: from wantadilla.lemis.com (wantadilla.lemis.com [192.109.197.135]) by ext-gw.lemis.com (Postfix) with ESMTP id 93234131E64; Fri, 2 Jun 2006 09:54:59 +0930 (CST) Received: by wantadilla.lemis.com (Postfix, from userid 1004) id 64B2886F56; Fri, 2 Jun 2006 09:54:59 +0930 (CST) Date: Fri, 2 Jun 2006 09:54:59 +0930 From: Greg 'groggy' Lehey To: Bruce Evans Message-ID: <20060602002459.GI80617@wantadilla.lemis.com> References: <200605311315.k4VDFUhD093628@repoman.freebsd.org> <20060601094950.GU21998@submonkey.net> <20060601100126.GA43737@FreeBSD.org> <200606010858.39417.jhb@freebsd.org> <20060602023102.J34761@delplex.bde.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="BOhpupldhMlYbdva" Content-Disposition: inline In-Reply-To: <20060602023102.J34761@delplex.bde.org> User-Agent: Mutt/1.4.2.1i Organization: The FreeBSD Project Phone: +61-8-8388-8286 Fax: +61-8-8388-8725 Mobile: +61-418-838-708 VoIP: sip:0871270137@sip.internode.on.net WWW-Home-Page: http://www.FreeBSD.org/ X-PGP-Fingerprint: 9A1B 8202 BCCE B846 F92F 09AC 22E6 F290 507A 4223 Cc: Maxim Konovalov , Alexey Dokuchaev , src-committers@freebsd.org, John Baldwin , cvs-src@freebsd.org, cvs-all@freebsd.org, Ceri Davies Subject: Re: cvs commit: src/sys/ufs/ufs ufs_vnops.c X-BeenThere: cvs-src@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: CVS commit messages for the src tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 02 Jun 2006 00:25:02 -0000 --BOhpupldhMlYbdva Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Friday, 2 June 2006 at 2:50:47 +1000, Bruce Evans wrote: > On Thu, 1 Jun 2006, John Baldwin wrote: > >> On Thursday 01 June 2006 06:01, Alexey Dokuchaev wrote: >>> On Thu, Jun 01, 2006 at 10:49:50AM +0100, Ceri Davies wrote: >>>> @@ -69,6 +69,10 @@ >>>> the file must be open for writing. >>>> .Sh RETURN VALUES >>>> .Rv -std >>>> +If the file to be modified is not a directory or >>>> +a regular file, the >>>> +.Fn truncate >>>> +call will return the value 0. >>> >>> Doesn't "value of 0" sound better? >> >> Not to me, though I can't explain why. I think the phrase "X will return >> the >> value Y" is common in man pages though. > > "will return" sounds strange to be. Yes, it will be better if you avoid the future tense. > Normal is "Upon successful completion, the value 0 is returned...". The passive is also to be avoided. How about "upon successful completion,\n.Nm\nreturns the value 0."? > This is part of what ".Rv -std" expands to. > > POSIX says "Upon successful completion, ftruncate( ) shall return 0...". Yes, but this is prescriptive. The man page should be descriptive. > The POSIX wording is better. "the value 0" says nothing more than > "0", It makes it clear that it's not a NULL pointer. > and "returns" is clearer than "is returned". Yes. > Saying "the value 0" is apparently a hack to give the clause a > subject (or is it an object? -- I think the value is the object > convoluted to a subject or vice versa). I don't think it makes any difference there. 0 is also a subject/object. Greg -- See complete headers for address and phone numbers. --BOhpupldhMlYbdva Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.1 (FreeBSD) iD8DBQFEf4VbIubykFB6QiMRAsU5AKCDJ7KJ5iNz/52sgH+mJTW3lnbIaACgmtr1 63UjOjJwflItX43PDnXD990= =2Bjb -----END PGP SIGNATURE----- --BOhpupldhMlYbdva--