ports/49955: [PATCH] bsd.port.mk: add target to automatically install port documentation

Oliver Eikemeier eikemeier at fillmore-labs.com
Tue Jan 27 16:43:50 PST 2004


Sergei Kolobov wrote:

> To summarize:
> 
> PORTDOCS dramatically reduces pkg-plist size in case
> there are a lot of files and/or subdirs under DOCSDIR.
> For example, PORTDOCS=*.
> 
> My patch (let's call it DOCS) is for far more common scenario
> (in my experience, at least) - there are just a few docs files
> which could (and should) be listed explicitly.
> 
> I just had an idea how this two approaches be combined into
> single framework:
> 
> Ports that have few doc files get this:
> 
> DOCS=		file1 file2 subdir/file3

this doesn't save you much compared with

	@cd ${WRKSRC}/doc && ${INSTALL_DATA} file1 file2 subdir/file3 ${DOCSDIR}

it yould be interesting when this macro could copy hierarchies. Anyway, do
you have a sample port the would benefit from a DOCS macro? I named to Java
ports a examples (using javadoc, i.e. junit, java3d, forte, whatever) for the
PORTDOCS macro, because

- they have dynamically generated documentation, changing often
- have a large, deep documentation tree
- install the documentation themselves
- don't always honour NOPORTDOCS

so a good candidate for your patch would be a port with a large, deep documentation
tree that isn't installed (bouncycastle). Or is your point that most people are too
lazy to write

PORTDOCS=	NEWS Changelog

.ifndef NOPORTDOCS
	@${MKDIR} ${DOCSDIR}
	@cd ${WRKSRC} && ${INSTALL_DATA} ${PORTDOCS} ${DOCSDIR}
.endif

but would use

DOCSSRC=	NEWS Changelog

instead?

And please avoid INSTALL_DOCS, it's too similar to INSTALL_MAN.



More information about the freebsd-ports mailing list