Date: Mon, 05 Jan 2009 05:44:35 +0900 (JST) From: Hiroki Sato <hrs@FreeBSD.org> To: chris@unixpages.org Cc: danger@FreeBSD.org, doc@FreeBSD.org Subject: Re: svn commit: r186737 - head/sbin/geom/class/virstor Message-ID: <20090105.054435.125149473.hrs@allbsd.org> In-Reply-To: <20090104194844.GB1257@haakonia.hitnet.RWTH-Aachen.DE> References: <1289663263.20090104185721@rulez.sk> <20090105.032211.33865530.hrs@allbsd.org> <20090104194844.GB1257@haakonia.hitnet.RWTH-Aachen.DE>
next in thread | previous in thread | raw e-mail | index | archive | help
----Security_Multipart(Mon_Jan__5_05_44_35_2009_132)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Christian Brueffer <chris@unixpages.org> wrote
in <20090104194844.GB1257@haakonia.hitnet.RWTH-Aachen.DE>:
ch> On Mon, Jan 05, 2009 at 03:22:11AM +0900, Hiroki Sato wrote:
ch> > I mean I am wondering if rewriting "1" with ">0" is reasonable or
ch> > not. "1>0" is always true, but "1" is not equal to ">0".
ch> >
ch> > Some other manual pages have the description "1 on error.". If we
ch> > have a consensus on that this rewriting is reasonable, we should
ch> > also rewrite them in consistency.
ch> >
ch>
ch> Interesting question, I have no strong opinion for either of the
ch> alternatives. I agree that we should standardize on one though.
IMO, the following guidelines are reasonable:
1. If the command conforms a standard such as POSIX, the description
in the manual page should match the standard. For example,
ls(1) returns >0 on error, but what(1) returns 1 on error.
2. Otherwise, EXIT STATUS section should match the reality as
possible. This means if a command returns 0 on success, 1 on
error, and the other values are not returned, the description in
the manual page should be "it exits 0 on success, and 1 if an
error occurs".
--
| Hiroki SATO
----Security_Multipart(Mon_Jan__5_05_44_35_2009_132)--
Content-Type: application/pgp-signature
Content-Transfer-Encoding: 7bit
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (FreeBSD)
iEYEABECAAYFAklhH7MACgkQTyzT2CeTzy2jWwCghTO+YZnKp1SjtWcLHKraBZDM
z5kAnjC8wwmIsfUEyk/xXbhlG8TUlWtT
=p+/e
-----END PGP SIGNATURE-----
----Security_Multipart(Mon_Jan__5_05_44_35_2009_132)----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20090105.054435.125149473.hrs>