From owner-freebsd-doc@FreeBSD.ORG Mon Sep 8 19:40:02 2008 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 71E361065679 for ; Mon, 8 Sep 2008 19:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 52ABA8FC18 for ; Mon, 8 Sep 2008 19:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.2/8.14.2) with ESMTP id m88Je2DU039329 for ; Mon, 8 Sep 2008 19:40:02 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.2/8.14.1/Submit) id m88Je2Qq039328; Mon, 8 Sep 2008 19:40:02 GMT (envelope-from gnats) Resent-Date: Mon, 8 Sep 2008 19:40:02 GMT Resent-Message-Id: <200809081940.m88Je2Qq039328@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Bruce Cran Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 9C8DB1065670 for ; Mon, 8 Sep 2008 19:31:45 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21]) by mx1.freebsd.org (Postfix) with ESMTP id 8F29B8FC19 for ; Mon, 8 Sep 2008 19:31:45 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from www.freebsd.org (localhost [127.0.0.1]) by www.freebsd.org (8.14.2/8.14.2) with ESMTP id m88JVjqe066667 for ; Mon, 8 Sep 2008 19:31:45 GMT (envelope-from nobody@www.freebsd.org) Received: (from nobody@localhost) by www.freebsd.org (8.14.2/8.14.1/Submit) id m88JVjMs066666; Mon, 8 Sep 2008 19:31:45 GMT (envelope-from nobody) Message-Id: <200809081931.m88JVjMs066666@www.freebsd.org> Date: Mon, 8 Sep 2008 19:31:45 GMT From: Bruce Cran To: freebsd-gnats-submit@FreeBSD.org X-Send-Pr-Version: www-3.1 Cc: Subject: docs/127219: [patch] style(9) is inconsistent regarding usage of sysexits(3) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 08 Sep 2008 19:40:02 -0000 >Number: 127219 >Category: docs >Synopsis: [patch] style(9) is inconsistent regarding usage of sysexits(3) >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon Sep 08 19:40:01 UTC 2008 >Closed-Date: >Last-Modified: >Originator: Bruce Cran >Release: 7.0-RELEASE-p3 >Organization: >Environment: FreeBSD tau.draftnet 7.0-RELEASE-p3 FreeBSD 7.0-RELEASE-p3 #1: Mon Aug 4 00:11:11 BST 2008 brucec@tau.draftnet:/usr/obj/usr/src/sys/MYKERNEL amd64 >Description: style(9) is inconsistent regarding the usage of sysexits(3): at one point it says Exits should be 0 on success, or according to the predefined values in sysexits(3). But in a later example: Use err(3) or warn(3), do not roll your own. if ((four = malloc(sizeof(struct foo))) == NULL) err(1, (char *)NULL); if ((six = (int *)overflow()) == NULL) errx(1, "number overflowed"); return (eight); } err and errx exit with a code of 1, which is incorrect according to the previous statement. Better exit codes might be EX_OSERR and EX_DATAERR. Also, the cast of NULL to char * isn't required. >How-To-Repeat: man 9 style >Fix: Patch attached with submission follows: --- /usr/src/share/man/man9/style.9 2007-01-28 20:51:04.000000000 +0000 +++ style.9 2008-09-08 20:20:31.000000000 +0100 @@ -716,9 +716,9 @@ do not roll your own. .Bd -literal if ((four = malloc(sizeof(struct foo))) == NULL) - err(1, (char *)NULL); + err(EX_OSERR, NULL); if ((six = (int *)overflow()) == NULL) - errx(1, "number overflowed"); + errx(EX_DATAERR, "number overflowed"); return (eight); } .Ed >Release-Note: >Audit-Trail: >Unformatted: