From owner-freebsd-doc Mon Nov 19 3:26:45 2001 Delivered-To: freebsd-doc@freebsd.org Received: from relay3-gui.server.ntli.net (relay3-gui.server.ntli.net [194.168.4.200]) by hub.freebsd.org (Postfix) with ESMTP id 2C83D37B417; Mon, 19 Nov 2001 03:26:39 -0800 (PST) Received: from pc3-card3-0-cust122.cdf.cable.ntl.com ([62.254.251.122] helo=rhadamanth.private.submonkey.net ident=exim) by relay3-gui.server.ntli.net with esmtp (Exim 3.03 #2) id 165mZP-0006G7-00; Mon, 19 Nov 2001 11:26:35 +0000 Received: from setantae by rhadamanth.private.submonkey.net with local (Exim 3.33 #1) id 165mYo-000H0G-00; Mon, 19 Nov 2001 11:25:58 +0000 Date: Mon, 19 Nov 2001 11:25:58 +0000 From: setantae To: "Gary W. Swearingen" Cc: FreeBSD-gnats-submit@FreeBSD.ORG, doc@FreeBSD.org Subject: Re: docs/32082: true.1 totally incorrect Message-ID: <20011119112558.GA65070@rhadamanth> Mail-Followup-To: setantae , "Gary W. Swearingen" , FreeBSD-gnats-submit@FreeBSD.ORG, doc@FreeBSD.org References: Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.3.23.2i 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 On Sun, Nov 18, 2001 at 09:34:29PM -0800, Gary W. Swearingen wrote: > Ceri writes: > > > >Description: > > true.1 states that the appropriate return status from true is "false". > > Which is clearly not the case. > > But it doesn't say that. It says it returns zero, which is correct. Well, it does; it says ``the appropriate status "false"'', which says to me that the appropriate return status from true is "false". But I don't really want to argue about that, as it's not the real point. > > ! It tests for the appropriate status "false" before running > > (or failing to run) a list of commands. > > The "It" here is confusingly referring to a Bourne shell script that > it confusingly brings into the description. Yeah, I didn't really understand that part at all, so I kind of skirted round it. Now that I've got a second opinion which is agreeable, how about this patch instead ? diff -rc src/usr.bin.old/false/false.1 src/usr.bin/false/false.1 *** src/usr.bin.old/false/false.1 Mon Nov 19 11:08:41 2001 --- src/usr.bin/false/false.1 Mon Nov 19 11:17:21 2001 *************** *** 46,62 **** .Sh DESCRIPTION The .Nm ! command is usually used in a Bourne shell script. ! It tests for the appropriate status "false" before running ! (or failing to run) a list of commands. ! .Pp ! The ! .Nm ! utility always exits with a value other than zero. .Sh SEE ALSO .Xr csh 1 , .Xr sh 1 , .Xr true 1 .Sh STANDARDS The .Nm --- 46,60 ---- .Sh DESCRIPTION The .Nm ! command does nothing but exit with a non-zero status. .Sh SEE ALSO .Xr csh 1 , .Xr sh 1 , .Xr true 1 + .Sh DIAGNOSTICS + The + .Nm + utility always returns with exit code one. .Sh STANDARDS The .Nm diff -rc src/usr.bin.old/true/true.1 src/usr.bin/true/true.1 *** src/usr.bin.old/true/true.1 Sun Nov 18 20:08:15 2001 --- src/usr.bin/true/true.1 Mon Nov 19 11:18:11 2001 *************** *** 46,54 **** .Sh DESCRIPTION The .Nm ! command is normally used in a Bourne shell script. ! It tests for the appropriate status "false" before running ! (or failing to run) a list of commands. .Sh SEE ALSO .Xr csh 1 , .Xr false 1 , --- 46,52 ---- .Sh DESCRIPTION The .Nm ! command does nothing but return a true status code. .Sh SEE ALSO .Xr csh 1 , .Xr false 1 , To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message