Skip to content

Confusing documentation in meta_merge and meta_add. #97

@sergiotarxz

Description

@sergiotarxz

Hi, I am a new CPAN contributor and have been struggling with the meta tags for some days.

Module::Build docs point out the following:

  • meta_add

    [version 0.28]

    A hash of key/value pairs that should be added to the META.yml file during the distmeta action. Any existing entries with the same names will be overridden.

    See the "MODULE METADATA" section for details.

So I went to that url and found the following:

  • MODULE METADATA

If you would like to add other useful metadata, Module::Build supports this with the meta_add and meta_merge arguments to "new()". The authoritative list of supported metadata can be found at CPAN::Meta::Spec but for convenience - here are a few of the more useful ones:

keywords

For describing the distribution using keyword (or "tags") in order to make CPAN.org indexing and search more efficient and useful.

resources

A list of additional resources available for users of the distribution. This can include links to a homepage on the web, a bug tracker, the repository location, and even a subscription page for the distribution mailing list.

So I went to the docs from CPAN::Meta::Spec:

resources => {
...,
    bugtracker  => {    
          web    => 'http://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-Meta',
          mailto => 'meta-bugs@example.com',
   },
...
}

This made me think I could have a web tracker configured and a mailto address, but when I tried resources were generated empty without any error.

Really I should have put bugtracker => 'url', but it is explained nowhere.

Thank you for your work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions