where to put examples?

[Blair Zajac]

On 10/23/2013 07:41 AM, Peter Danecek wrote:
>
> Hi Ryan!
>
> On Oct 18, 2013, at 1:43 , Ryan Schmidt <ryandesign at macports.org> wrote:
>
>>
>> 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.
>
> Okay, this all makes sense to me.
>
>> 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.

I disagree, I don't find $prefix/share/examples natural at all, maybe 
because Linux doesn't have this directory at all.  I'm used to only 
looking in $prefix/share/doc/$subport for any additional samples, 
documentation, examples.

I do request that all content documentation and example content be 
findable from $prefix/share/doc/$subport, even if it is a symlink.

> So here I would propose that the Python Portgroup should NOT create this ${prefix}/share/doc/${subport}/examples directory at all.

Again, I think it should have it, and it can be a symlink.

Regards,
Blair