From owner-freebsd-ports@FreeBSD.ORG Mon Nov 23 12:21:37 2009 Return-Path: Delivered-To: freebsd-ports@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id C34931065672 for ; Mon, 23 Nov 2009 12:21:37 +0000 (UTC) (envelope-from m.seaman@infracaninophile.co.uk) Received: from smtp.infracaninophile.co.uk (gate6.infracaninophile.co.uk [IPv6:2001:8b0:151:1::1]) by mx1.freebsd.org (Postfix) with ESMTP id 59C798FC18 for ; Mon, 23 Nov 2009 12:21:37 +0000 (UTC) Received: from significant-gravitas-shortfall.thebunker.net (gateway.ash.thebunker.net [213.129.64.4]) (authenticated bits=0) by smtp.infracaninophile.co.uk (8.14.3/8.14.3) with ESMTP id nANCLPT4069128 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Mon, 23 Nov 2009 12:21:32 GMT (envelope-from m.seaman@infracaninophile.co.uk) X-DKIM: Sendmail DKIM Filter v2.8.3 smtp.infracaninophile.co.uk nANCLPT4069128 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=infracaninophile.co.uk; s=200708; t=1258978892; bh=LydyrDSly4bJ7BXCjlIb0OGvc/gk6Ug0BQuZv9PxekQ=; h=Message-ID:Date:From:MIME-Version:To:CC:Subject:References: In-Reply-To:Content-Type:Cc:Content-Type:Date:From:In-Reply-To: Message-ID:Mime-Version:References:To; z=Message-ID:=20<4B0A7E3E.4020500@infracaninophile.co.uk>|Date:=20M on,=2023=20Nov=202009=2012:21:18=20+0000|From:=20Matthew=20Seaman= 20|Organization:=20Infracaninophi le|User-Agent:=20Thunderbird=202.0.0.23=20(X11/20090824)|MIME-Vers ion:=201.0|To:=20David=20Fries=20|CC:=20freebsd-ports@ freebsd.org|Subject:=20Re:=20Newbie=20question=20about=20additiona l=20documentation|References:=20<20091123112929.151170@gmx.net>|In -Reply-To:=20<20091123112929.151170@gmx.net>|X-Enigmail-Version:=2 00.95.7|OpenPGP:=20id=3D60AE908C|Content-Type:=20multipart/signed= 3B=20micalg=3Dpgp-sha1=3B=0D=0A=20protocol=3D"application/pgp-sign ature"=3B=0D=0A=20boundary=3D"------------enig697C68ADD12799A0CF9C BE6F"; b=J1tU1e/5Q1OFfRnyu5H5k2jG5mxket+yjJUvLfo6fiOq8AfgpLpx01MczfPLTRUbS Cmnxdht/2NwtxZPIpxsFiYhxKyTtmR71JFhwX4dwwuNUylxk2Vgs+HY0Oe9KU805Ug f2epi2Ff/EHoAep3vp/OCWe8B2WS4nxKDdpUgDH0= X-Authentication-Warning: happy-idiot-talk.infracaninophile.co.uk: Host gateway.ash.thebunker.net [213.129.64.4] claimed to be significant-gravitas-shortfall.thebunker.net Message-ID: <4B0A7E3E.4020500@infracaninophile.co.uk> Date: Mon, 23 Nov 2009 12:21:18 +0000 From: Matthew Seaman Organization: Infracaninophile User-Agent: Thunderbird 2.0.0.23 (X11/20090824) MIME-Version: 1.0 To: David Fries References: <20091123112929.151170@gmx.net> In-Reply-To: <20091123112929.151170@gmx.net> X-Enigmail-Version: 0.95.7 OpenPGP: id=60AE908C Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="------------enig697C68ADD12799A0CF9CBE6F" X-Virus-Scanned: clamav-milter 0.95.3 at happy-idiot-talk.infracaninophile.co.uk X-Virus-Status: Clean X-Spam-Status: No, score=-2.6 required=5.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VERIFIED,SPF_FAIL autolearn=no version=3.2.5 X-Spam-Checker-Version: SpamAssassin 3.2.5 (2008-06-10) on happy-idiot-talk.infracaninophile.co.uk Cc: freebsd-ports@freebsd.org Subject: Re: Newbie question about additional documentation X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 23 Nov 2009 12:21:37 -0000 This is an OpenPGP/MIME signed message (RFC 2440 and 3156) --------------enig697C68ADD12799A0CF9CBE6F Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable David Fries wrote: > Hi everybody >=20 > I started working on my first port (a Haskell cabal package) over the > last weekend. I read the porter's handbook and then began by looking > at similar ports that already existed in the ports collection (e.g. > archivers/hs-zlib) to get a basic idea of what the port should look > like. I noticed that the only documentation listed in pkg-plist of > these ports is the LICENSE file. So pkg-plist looks something like > this: >=20 > ... other files.. > %%PORTDOCS%%%%DOCSDIR%%/LICENSE > %%PORTDOCS%%@dirrm %%DOCSDIR%% > ... @exec/@unexec... >=20 > However, when you install the port (assuming NOPORTDOCS is not set), > a HTML documentation will also be generated by the Haskell compiler > and put into %%PORTDOCS%%%%DOCSDIR%%/html/*. So my question is, is it > ok to omit these html files in the pkg-plist? I thought, you should > list those too... It's not OK to install files without any record in the pkgdb. If you do things like that, firstly any committer working on the port should bounce= it back to you as not fulfilling the required standards, and secondly, if= the port does somehow get committed you'll be getting irate e-mails from various QA systems that spend all their time looking for such problems. Now, explicitly listing all of the files that get installed in pkg-plist in the port directory is one way of dealing with this. There are alterna= tives though, which might suit your port better. Check out the PLIST_FILES and= PORTDOCS variables in /usr/ports/Mk/bsd.port.mk -- in short these are: PLIST_FILES a way of listing a short pkg_plist entirely from within the port Makefile, which helps avoid using up inodes for tiny little files =20 PORTDOCS a way of automatically adding a whole directory tree of documentation to the pkg pretty much automatically. This is particularly useful if your docco is generated automatically and you can't always know exactly what files there will be beforehand. Cheers, Matthew --=20 Dr Matthew J Seaman MA, D.Phil. Flat 3 7 Priory Courtyard PGP: http://www.infracaninophile.co.uk/pgpkey Ramsgate Kent, CT11 9PW, UK --------------enig697C68ADD12799A0CF9CBE6F Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.13 (FreeBSD) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org iEYEARECAAYFAksKfkUACgkQ3jDkPpsZ+VZVWQCcDYa2xS/gKCLckrjB0Aetuw+0 X9oAn1xCnbnQsL4PKbQ9DmODyAwbCH2p =CzfK -----END PGP SIGNATURE----- --------------enig697C68ADD12799A0CF9CBE6F--