From owner-freebsd-doc@FreeBSD.ORG Tue Jan 6 23:31:15 2009 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 86CA21065670; Tue, 6 Jan 2009 23:31:15 +0000 (UTC) (envelope-from keramida@freebsd.org) Received: from mx-out.forthnet.gr (mx-out.forthnet.gr [193.92.150.104]) by mx1.freebsd.org (Postfix) with ESMTP id E4A9B8FC14; Tue, 6 Jan 2009 23:31:14 +0000 (UTC) (envelope-from keramida@freebsd.org) Received: from mx-av-06.forthnet.gr (mx-av.forthnet.gr [193.92.150.27]) by mx-out-05.forthnet.gr (8.14.3/8.14.3) with ESMTP id n06NEdkB025258; Wed, 7 Jan 2009 01:14:39 +0200 Received: from MX-IN-02.forthnet.gr (mx-in-02.forthnet.gr [193.92.150.185]) by mx-av-06.forthnet.gr (8.14.3/8.14.3) with ESMTP id n06NEdk7012096; Wed, 7 Jan 2009 01:14:39 +0200 Received: from kobe.laptop (ppp160-148.adsl.forthnet.gr [194.219.40.148]) by MX-IN-02.forthnet.gr (8.14.3/8.14.3) with ESMTP id n06NEW01015924; Wed, 7 Jan 2009 01:14:33 +0200 Authentication-Results: MX-IN-02.forthnet.gr smtp.mail=keramida@freebsd.org; spf=permerror Authentication-Results: MX-IN-02.forthnet.gr header.from=keramida@freebsd.org; sender-id=permerror Received: from kobe.laptop (kobe.laptop [127.0.0.1]) by kobe.laptop (8.14.3/8.14.3) with ESMTP id n06NEWuH091085; Wed, 7 Jan 2009 01:14:32 +0200 (EET) (envelope-from keramida@freebsd.org) Received: (from keramida@localhost) by kobe.laptop (8.14.3/8.14.3/Submit) id n06NEVnQ091084; Wed, 7 Jan 2009 01:14:32 +0200 (EET) (envelope-from keramida@freebsd.org) From: Giorgos Keramidas To: Daniel Gerzo In-Reply-To: <287359450.20090104174842@rulez.sk> (Daniel Gerzo's message of "Sun, 4 Jan 2009 17:48:42 +0100") Date: Wed, 07 Jan 2009 01:10:25 +0200 Message-ID: <87k598rpy6.fsf@kobe.laptop> References: <200901041541.n04Ff1Oh060753@svn.freebsd.org> <20090104155832.GA1257@haakonia.hitnet.RWTH-Aachen.DE> <287359450.20090104174842@rulez.sk> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.0.60 (berkeley-unix) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: doc@freebsd.org, Christian Brueffer Subject: Re: svn commit: r186737 - head/sbin/geom/class/virstor 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: Tue, 06 Jan 2009 23:31:15 -0000 On Sun, 4 Jan 2009 17:48:42 +0100, Daniel Gerzo wrote: > Hello Christian, > > Sunday, January 4, 2009, 4:58:32 PM, you wrote: > >> While using .Ex is good, collapsing EXIT STATUS into DIAGNOSTICS is not. >> EXIT STATUS is a standard section in our manpages and it's orthogonal to >> DIAGNOSTICS. > > I am fine to revert this part, however I have trimmed this section > just because I didn't see it listed in the PAGE STRUCTURE DOMAIN > section of the mdoc(7) manual page. > > Interestingly, it lists the DIAGNOSTICS section and explicitly > says that .Ex macro should be used there. Then the mdoc(7) manpage needs updating. IIRC it was Ruslan who first started using the EXIT STATUS section, but it looks nice in a very prominent place of many manpages. A few that I can remember off the top of my head (only because I went through their text recently) are: ls.1 chmod.1 chown.1 dump.8 > If is it still preferred to revert this change, I would like to see > this section added to the mdoc(7). Thoughts? Yes please. I'd like to see EXIT STATUS described in groff_mdoc.7 and a few examples of appropriate use added. Something that describes how we should use the `.Ex -std' macro, when -std is not enough, and/or a few words about the preferred way of spelling out exit codes would be pretty awesome.