Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 08 Nov 2003 03:35:37 +0100
From:      Oliver Eikemeier <eikemeier@fillmore-labs.com>
To:        Sergey Matveychuk <sem@ciam.ru>
Cc:        freebsd-ports@freebsd.org
Subject:   Re: Does new PORTDOCS macro mork?
Message-ID:  <3FAC5679.9050003@fillmore-labs.com>
In-Reply-To: <3FAC462D.6060006@ciam.ru>
References:  <3FAC2F86.3050009@ciam.ru> <1068253220.22635.5.camel@shumai.marcuscom.com> <3FAC462D.6060006@ciam.ru>

next in thread | previous in thread | raw e-mail | index | archive | help
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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?3FAC5679.9050003>