From owner-freebsd-ports@FreeBSD.ORG Fri Nov 7 18:35:54 2003 Return-Path: Delivered-To: freebsd-ports@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id D11C516A4CE for ; Fri, 7 Nov 2003 18:35:54 -0800 (PST) Received: from mx2.fillmore-labs.com (lima.fillmore-labs.com [62.138.193.83]) by mx1.FreeBSD.org (Postfix) with ESMTP id ECFDB43FBF for ; Fri, 7 Nov 2003 18:35:53 -0800 (PST) (envelope-from eikemeier@fillmore-labs.com) Received: from p5080b418.dip.t-dialin.net ([80.128.180.24] helo=fillmore-labs.com ident=xjwqhe04o147yrku) by mx2.fillmore-labs.com with asmtp (TLSv1:AES256-SHA:256) (Exim 4.24; FreeBSD 4.9) id 1AIIx2-000G1G-K5; Sat, 08 Nov 2003 03:35:48 +0100 Message-ID: <3FAC5679.9050003@fillmore-labs.com> Date: Sat, 08 Nov 2003 03:35:37 +0100 From: Oliver Eikemeier MIME-Version: 1.0 To: Sergey Matveychuk References: <3FAC2F86.3050009@ciam.ru> <1068253220.22635.5.camel@shumai.marcuscom.com> <3FAC462D.6060006@ciam.ru> In-Reply-To: <3FAC462D.6060006@ciam.ru> Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit X-Authenticated-Sender: eikemeier@fillmore-labs.com User-Agent: KMail/1.5.9 Organization: Fillmore Labs GmbH X-Complaints-To: abuse@fillmore-labs.com cc: freebsd-ports@freebsd.org Subject: Re: Does new PORTDOCS macro mork? X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 08 Nov 2003 02:35:54 -0000 Sergey Matveychuk wrote: > Joe Marcus Clarke wrote: > >> Setting this macro only adds plist entries to the final package >> +CONTENTS file (just like INFO and MAN do). You will still have to >> physically install these files. For example: > > But would I need installs INFO and MAN files by hands? > >> PORTDOCS= FAQ SECURITY CREDITS ChangeLog >> ... >> .for i in ${PORTDOCS} >> ${INSTALL_DATA} ${WRKSRC}/doc/${i} ${DOCSDIR} >> .endfor > > > And what about PR/49955? It makes both. Sorry, somehow I forgot to submit the documentation: --- Mk/bsd.port.mk 7 Nov 2003 17:55:41 -0000 +++ Mk/bsd.port.mk 8 Nov 2003 01:44:23 -0000 @@ -583,6 +583,14 @@ # # INFO - A list of .info files (omitting the trailing ".info"); # only one entry per document! +# Set the following to specify all documentation your port installs into ${DOCSDIR} +# +# PORTDOCS - A list of files and directories relative to DOCSDIR. +# Shell glob patterns can be used, directories include +# the entire subtree of contained files and directories. +# Should not be set when no documentation files are +# installed (for example because NOPORTDOCS is defined). +# Useful for dynamically generated documentation. # # Default targets and their behaviors: # The only thing that PR 49955 does which PR 57778 doesn't is post-install: @${MKDIR} ${DOCSDIR} @cd ${WRKSRC}/doc && ${INSTALL_DATA} ${PORTDOCS} ${DOCSDIR} which is easy and should not complicate a ports Makefile. What the PORTDOCS macro does address is stuff like dynamically generated documentation or documentation that changes from release to release, an good example where this really helps is `Javadocs and pkg-plist': http://lists.freebsd.org/pipermail/freebsd-ports/2003-October/005830.html You'll also find some of the discussion in both PRs. The rationale is that installing files is easy, but building the packing list hard (and error prone). Regards Oliver