how to avoid cpan indexing ?

[Jaap Karssenberg]

I have a package that is supposed to go to cpan which contains a module
that is only needed at build/install time, so it isn't intended for
re-use and also it will never conflict with anything because it is
loaded in one special situation only. Previous experiences have learnt
me that cpan will index each and every .pm file and put it in the
database, thus my module will be indexed and cause pollution of the
database.

Now my question is, is there a way to avoid indexing, is there a way to
mark files as not to be indexed ? I see some examples use a "My::"
namespace, is this namespace perhaps special in some way ?

( please note that it isn't an option to simply give the file another
extension )

--
) ( Jaap Karssenberg || Pardus [Larus] | |0| |
: : [url]http://pardus-larus.student.utwente.nl/~pardus[/url] | | |0|
) \ / ( |0|0|0|
",.*'*.," Proud owner of "Perl6 Essentials" 1st edition :) wannabe

[Jim Keenan]

"Jaap Karssenberg" <j.g.karssenberg@student.utwente.nl> wrote in message
news:20040124151550.2e4ab25b@Captain...

> I have a package that is supposed to go to cpan which contains a module
> that is only needed at build/install time, so it isn't intended for
> re-use and also it will never conflict with anything because it is
> loaded in one special situation only. Previous experiences have learnt
> me that cpan will index each and every .pm file and put it in the
> database, thus my module will be indexed and cause pollution of the
> database.
>
> Now my question is, is there a way to avoid indexing, is there a way to
> mark files as not to be indexed ? I see some examples use a "My::"
> namespace, is this namespace perhaps special in some way ?
>

By indexing, do you mean [url]http://www.cpan.org/modules/01modules.index.html[/url] ?
Or do you mean a search engine such as search.cpan.org or
kobesearch.cpan.org?

The former simply lists distributions, not the .pm files inside each
distribution. So I'm going to assume you're talking about one or both of
the search engines.

What follows is *a* solution but not necessarily the best solution: Can you
put it in a t/Test directory? I suggest this because I notice that in each
of my 2 CPAN distributions, .pm files which I place in t/Test do not get
displayed on their distributions' respective main pages. They only appear
in the MANIFEST. On the other hand, sample .pm files which I did *not* put
in t/Test did get indexed. (Cf.
[url]http://search.cpan.org/~jkeenan/Data-Presenter-0.64/[/url])

I can't guarantee that this will work with modules which are needed at
points in the build/install process *other than* testing. Perhaps others
can provide a more definitive answer.

jimk

[Jaap Karssenberg]

X-Newsreader: Sylpheed version 0.9.8claws (GTK+ 1.2.10; i686-pc-linux-gnu)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

On Sat, 24 Jan 2004 17:05:26 GMT Jim Keenan wrote:
: By indexing, do you mean
: [url]http://www.cpan.org/modules/01modules.index.html[/url] ? Or do you mean a
: search engine such as search.cpan.org or kobesearch.cpan.org?
:
: The former simply lists distributions, not the .pm files inside each
: distribution. So I'm going to assume you're talking about one or both
: of the search engines.

I was talking about the PAUSE namespace indexer which I mistook for a
CPAN feature.

--
) ( Jaap Karssenberg || Pardus [Larus] | |0| |
: : [url]http://pardus-larus.student.utwente.nl/~pardus[/url] | | |0|
) \ / ( |0|0|0|
",.*'*.," Proud owner of "Perl6 Essentials" 1st edition :) wannabe

[Randy Kobes]

"Jaap Karssenberg" <j.g.karssenberg@student.utwente.nl> wrote in message
news:20040124151550.2e4ab25b@Captain...

> I have a package that is supposed to go to cpan which contains a module
> that is only needed at build/install time, so it isn't intended for
> re-use and also it will never conflict with anything because it is
> loaded in one special situation only. Previous experiences have learnt
> me that cpan will index each and every .pm file and put it in the
> database, thus my module will be indexed and cause pollution of the
> database.
>
> Now my question is, is there a way to avoid indexing, is there a way to
> mark files as not to be indexed ? I see some examples use a "My::"
> namespace, is this namespace perhaps special in some way ?
>
> ( please note that it isn't an option to simply give the file another
> extension )

Could you just leave the private modules out of the distribution
and generate them dynamically at the 'perl Makefile.PL' stage (eg,
have them in a __DATA__ section that gets printed out).

best regards,
randy kobes

[Slaven Rezic]

Jaap Karssenberg <j.g.karssenberg@student.utwente.nl> writes:

> I have a package that is supposed to go to cpan which contains a module
> that is only needed at build/install time, so it isn't intended for
> re-use and also it will never conflict with anything because it is
> loaded in one special situation only. Previous experiences have learnt
> me that cpan will index each and every .pm file and put it in the
> database, thus my module will be indexed and cause pollution of the
> database.
>
> Now my question is, is there a way to avoid indexing, is there a way to
> mark files as not to be indexed ? I see some examples use a "My::"
> namespace, is this namespace perhaps special in some way ?
>
> ( please note that it isn't an option to simply give the file another
> extension )

I see two solutions:

* Put the "package" declaration in two lines. In this case the PAUSE
indexer will ignore the package:

package # hide from indexer
My::Module;

* I think you can put a "private" hash to the META.yml file, though I
don't know where to find more information about it.

Regards,
Slaven

--
Slaven Rezic - [email]slaven@rezic.de[/email]
BBBike - route planner for cyclists in Berlin
WWW version: [url]http://www.bbbike.de[/url]
Perl/Tk version for Unix and Windows: [url]http://bbbike.sourceforge.net[/url]

[Norbert Gruener]

On Sun, Jan 25 2004, Slaven Rezic wrote:

> Jaap Karssenberg <j.g.karssenberg@student.utwente.nl> writes:
>

> > I have a package that is supposed to go to cpan which contains a module

[snipped]

> > database.
> >
> > Now my question is, is there a way to avoid indexing, is there a way to
> > mark files as not to be indexed ? I see some examples use a "My::"
> > namespace, is this namespace perhaps special in some way ?

>
> I see two solutions:
>

[snipped]

>
> * I think you can put a "private" hash to the META.yml file, though I
> don't know where to find more information about it.

I am having the same problem and I am desperately searching for
information how to set up the META.yml file :-((

Where can I find more information about it ?

Cheers,

Norbert
--
Ceterum censeo | PGP encrypted mail preferred.
Redmond esse delendam. | PGP Key at [url]www.MPA-Garching.MPG.de/~nog/[/url]

[Peter Hickman]

Norbert Gruener wrote:

> I am having the same problem and I am desperately searching for
> information how to set up the META.yml file :-((

perl Makefile.PL
make
make dist

The last step will create the META.yml file for you.

[Norbert Gruener]

On Wed, Feb 04 2004, Peter Hickman wrote:

> Norbert Gruener wrote:

> >I am having the same problem and I am desperately searching for
> >information how to set up the META.yml file :-((

>
> perl Makefile.PL
> make
> make dist
>
> The last step will create the META.yml file for you.

Yes, I know. But this does not solve the original question

"how to avoid cpan indexing"

But in the meantime I found out that this kind of problem is discussed
on the "Module-build-general" mailing list.

Thank you for your help.

Cheers,

Norbert
--
Ceterum censeo | PGP encrypted mail preferred.
Redmond esse delendam. | PGP Key at [url]www.MPA-Garching.MPG.de/~nog/[/url]