From owner-freebsd-doc@FreeBSD.ORG  Fri Aug 20 15:41:02 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id E7E1516A4CE; Fri, 20 Aug 2004 15:41:02 +0000 (GMT)
Received: from tarjoilu.luukku.com (tarjoilu.luukku.com [194.215.205.232])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 9D03343D2D; Fri, 20 Aug 2004 15:41:02 +0000 (GMT)
	(envelope-from koston@iki.fi)
Received: from localhost (mta1-o.i.luukku.com [10.0.1.112])
	by mta1-o.i.luukku.com (Postfix) with ESMTP id 5F29581DD0;
	Fri, 20 Aug 2004 18:41:01 +0300 (EEST)
Received: from norsu.kameli.org (ip213-185-39-27.laajakaista.mtv3.fi
	[213.185.39.27])
	by tarjoilu.luukku.com (Postfix) with SMTP id 23D033AE28B;
	Fri, 20 Aug 2004 18:41:01 +0300 (EEST)
Received: by norsu.kameli.org (sSMTP sendmail emulation);
	Fri, 20 Aug 2004 18:41:06 +0000
From: "Atte Peltomaki" <koston@iki.fi>
Date: Fri, 20 Aug 2004 18:41:06 +0000
To: "Simon L. Nielsen" <simon@FreeBSD.org>
Message-ID: <20040820184105.GA49742@norsu.kameli.org>
References: <20040820145251.GA36893@norsu.kameli.org>
	<20040820165602.GA737@norsu.kameli.org>
	<20040820144228.GB3997@orion.daedalusnetworks.priv>
	<20040820145359.GA16841@eddie.nitro.dk>
Mime-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20040820145359.GA16841@eddie.nitro.dk>
User-Agent: Mutt/1.4.2.1i
cc: freebsd-doc@freebsd.org
Subject: Re: Manpage for snd_solo
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 20 Aug 2004 15:41:03 -0000

> > > here's the solo.4 manpage as attachment, too.
> > 
> > > .Dd August 20, 2004
> > > .Dt SOLO 4
> > > .Os
> > > .Sh NAME
> > > .Nm solo 
> > > .Nd
> > > .Fx
> > > ESS Solo-1/1E PCI bridge device driver
> >
> > I'm not sure if makewhatis(1) or other tools that automatically extract
> > the name and description of manpages is going to be happy with .Nd being
> > split in multiple lines.  If this is a possible source of problems, we
> > can always rewrite this as:
> > 
> >         .Nm solo
> >         .Nd ESS Solo-1/1E PCI bridge device driver
> > 
> > since other sound drivers (i.e. gusc(4)) use this scheme already :-)
> 
> Also, it's a bit implicit that the driver is for FreeBSD :-).
> 
> > Otherwise this looks fine to me.  If nobody else feels like it I'll
> > commit it later tonight or early tomorrow morning (Sat Aug 21).
> 
> I have a few comments (e.g. mainly there should be a HARDWARE
> section), but I'm on my way out the door now.  I will have a more
> detailed look either tonight or tommorow, so please hold with
> comitting until then.

I have been noted of the example.[1|2|4] files, and the HARDWARE 
section. I did the solo.4 page based on the old csa.4 page, so any 
mistakes there were directly copied over. I've never before done
anything with groff, so I'm still on a bit thin ice. 

I'll regard these replies as "go ahead", so I'm starting work on
snd_* and sound manpages asap. I'm expecting to have more done
by the end of sunday.


Atte Peltomäki
http://kameli.org