It's already a common convention for module authors to have an 'eg' directory which contains examples.

How about making this into a top level namespace (Generally top level namespaces are discouraged, but in this case it might be beneficial and encourage other authors to place more robust and visible examples).

Eg::XS::FastHash

or

XS::Eg::FastHash

or

XS::FastHash::Eg


On 06/07/2012 06:14 PM, bulk 88 wrote:

I have a XS module I wrote as a sample, example or tutorial on how to do increase the 
performance of perl hashes on an XS level. It doesn't do anything useful on its own other 
provide 2 XSUBs which are supposed to be benchmarked against each other to show the 
traditional vs my "new" way of doing things. It exports nothing 
C/.so/.a/.lib/.dll or Perl wise. It's test file just does the benchmark. It doesn't link 
with anything except a stock perl and a stock c std lib. It only real purpose is to be 
copied into other XS modules and be studied from. What namespace should it go under? I 
thought its name should be FastHash or XSFasterHashes. Example::FastHash? Example:: 
already exists. Sample:: doesn't exist. XS:: exists, XS::Example doesn't, so 
XS::Example::FastHash? Module::FastHash? (I dont like that) Module::Example::FastHash? 
Acme::FastHash? Acme::Tutorial::FastHash? I dont find Acme:: offensive, its a good way to 
prove the module doesn't do anything on its own and its not int
ended to be use'd.
                                        

Reply via email to