Scroll to navigation

Pod::Weaver::Section::Bugs(3pm) User Contributed Perl Documentation Pod::Weaver::Section::Bugs(3pm)

NAME

Pod::Weaver::Section::Bugs - a section for bugtracker info

VERSION

version 4.015

OVERVIEW

This section plugin will produce a hunk of Pod giving bug reporting information for the document, like this:

  =head1 BUGS
  Please report any bugs or feature requests on the bugtracker website
  http://rt.cpan.org/Dist/Display.html?Queue=Pod-Weaver
  When submitting a bug or request, please include a test-file or a
  patch to an existing test-file that illustrates the bug or desired
  feature.

This plugin requires a "distmeta" parameter containing a hash reference of CPAN::Meta::Spec distribution metadata and at least one of one of the parameters "web" or "mailto" defined in "$meta->{resources}{bugtracker}".

Using Pod::Weaver::Section::Bugs with Dist::Zilla

When the PodWeaver plugin is used, the "distmeta" parameter comes from the dist's distmeta data. Since this section is skipped when no bugtracker data is in the distmeta, you'll need to make sure it's there. A number of plugins set this data up automatically. To manually configure your bugtracker data, you can add something like the following to "dist.ini":

  [MetaResources]
  bugtracker.web = http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Weaver-Example
  bugtracker.mailto = bug-pod-weaver-example@rt.cpan.org
  ; Perhaps add repository stuff here:
  repository.url =
  repository.web =
  repository.type =
  [PodWeaver]

ATTRIBUTES

The title of the header to be added. (default: "BUGS")

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2016-10-22 perl v5.24.1