diff --git a/en_US.ISO8859-1/books/porters-handbook/book.sgml b/en_US.ISO8859-1/books/porters-handbook/book.sgml index 09fe45d3c5..72adc91f13 100644 --- a/en_US.ISO8859-1/books/porters-handbook/book.sgml +++ b/en_US.ISO8859-1/books/porters-handbook/book.sgml @@ -4254,9 +4254,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar 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 @@ -6820,7 +6818,8 @@ post-install: ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR} .endif - Here are some variables and how they are expanded when used + Here are some variables and how they are expanded + by default when used in the Makefile: @@ -6858,6 +6857,28 @@ post-install: pkg-message does not need to be added to pkg-plist. + + As an alternative to enumerating the documentation files + in pkg-plist, a port can set the variable + PORTDOCS to a list of file names and shell + glob patterns to add to the final packing list. + The names will be relative to DOCSDIR. + Therefore, a port that utilizes PORTDOCS and + uses a non-default location for its documentation should set + DOCSDIR accordingly. + If a directory is listed in PORTDOCS + or matched by a glob pattern from this variable, + the entire subtree of contained files and directories will be + registered in the final packing list. 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