where to put examples?

Ryan Schmidt ryandesign at macports.org
Thu Oct 17 16:43:30 PDT 2013


On Oct 17, 2013, at 10:18, Peter Danecek <Peter.Danecek at bo.ingv.it> wrote:

> There is some note in porthier(7) which might suggest documentation would go into ${prefix}/share/doc and examples into ${prefix}/share/examples, no further details. 

This is what I would view as correct. More specifically: documentation goes in ${prefix}/share/doc/${subport} and examples in ${prefix}/share/examples/${subport}.

The version number usually does not belong in these paths because there can only be one version of a port active at one time.

${prefix}/share/${subport} is a location where ports can install any architecture-agnostic files they may need. Some build systems may also put documentation or examples here. If I did anything about this in a portfile it would probably just be to install symlinks at ${prefix}/share/doc/${subport} and ${prefix}/share/examples/${subport} pointing to the places within ${prefix}/share/${subport} where the build system installed them.

If other documentation, portfiles or portgroups puts these files elsewhere, ideally they should be fixed. For example, ${prefix}/share/doc/${subport}/examples seems wrong to me.





More information about the macports-dev mailing list