Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 19 Nov 2001 11:25:58 +0000
From:      setantae <setantae@submonkey.net>
To:        "Gary W. Swearingen" <swear@blarg.net>
Cc:        FreeBSD-gnats-submit@FreeBSD.ORG, doc@FreeBSD.org
Subject:   Re: docs/32082: true.1 totally incorrect
Message-ID:  <20011119112558.GA65070@rhadamanth>
In-Reply-To: <d38zd3493u.zd3@localhost.localdomain>
References:  <E165YJb-000EfO-00@rhadamanth.private.submonkey.net> <d38zd3493u.zd3@localhost.localdomain>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, Nov 18, 2001 at 09:34:29PM -0800, Gary W. Swearingen wrote:
> Ceri <setantae@submonkey.net> 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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011119112558.GA65070>