From owner-freebsd-ports@FreeBSD.ORG Sat Jun 19 12:24:03 2004 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 AF48A16A4CF for ; Sat, 19 Jun 2004 12:24:03 +0000 (GMT) Received: from comp.chem.msu.su (comp.chem.msu.su [158.250.32.97]) by mx1.FreeBSD.org (Postfix) with ESMTP id 5141043D5C for ; Sat, 19 Jun 2004 12:24:01 +0000 (GMT) (envelope-from yar@comp.chem.msu.su) Received: from comp.chem.msu.su (localhost [127.0.0.1]) by comp.chem.msu.su (8.12.9p2/8.12.9) with ESMTP id i5JCNbYj074844 for ; Sat, 19 Jun 2004 16:23:38 +0400 (MSD) (envelope-from yar@comp.chem.msu.su) Received: (from yar@localhost) by comp.chem.msu.su (8.12.9p2/8.12.9/Submit) id i5JCNbDY074843 for ports@freebsd.org; Sat, 19 Jun 2004 16:23:37 +0400 (MSD) (envelope-from yar) Date: Sat, 19 Jun 2004 16:23:36 +0400 From: Yar Tikhiy To: ports@freebsd.org Message-ID: <20040619122336.GA72313@comp.chem.msu.su> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.6i Subject: PORTDOCS in the Porter's Handbook 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, 19 Jun 2004 12:24:03 -0000 Hi folks, The neat PORTDOCS variable deserves more attention in the Porter's Handbook, doesn't it? Hope I got it right... Could anybody review the below patch? Thank you! -- Yar Index: book.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.429 diff -u -r1.429 book.sgml --- book.sgml 16 Jun 2004 09:48:26 -0000 1.429 +++ book.sgml 19 Jun 2004 12:05:22 -0000 @@ -4218,9 +4218,8 @@ JDK, it is therefore a complex task to specify the packing list (pkg-plist). This is one reason why porters are strongly encouraged to use the - PORTDOCS macro. This feature is yet well - documented, so you should refer to bsd.port.mk - itself for further information. Moreover, even if you can + PORTDOCS macro. + Moreover, even if you can predict the set of files that will be generated by javadoc, the size of the resulting pkg-plist advocates for the use of @@ -6784,6 +6783,26 @@ pkg-message does not need to be added to pkg-plist. + + Recently a new feature was introduced to the ports framework + in order to facilitate registering port documentation. Instead of + listing all the documentation files in the packing list with the + somewhat clumsy %%PORTDOCS%% prefix, now a porter + can set the variable PORTDOCS to a list of + file names and shell glob patterns relative to + DOCSDIR. If a directory is listed or matched + by a glob pattern, the entire subtree of contained files and + directories will be registered. PORTDOCS + should not be set if NOPORTDOCS is in + effect. Installing the documentation at PORTDOCS + as shown above remains up to the port itself. + A typical example of utilizing PORTDOCS + looks as follows: + + .if !defined(NOPORTDOCS) + PORTDOCS= * +.endif +