NAME

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

VERSION

version 4.018

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]

PERL VERSION SUPPORT

This module has the same support period as perl itself: it supports the two most recent versions of perl. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

ATTRIBUTES

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

AUTHOR

Ricardo SIGNES <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 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.