1. Manuals
  2. Tumbleweed
  3. perl-Pod-Readme
  4. Pod::Readme::Plugin::changes(3pm)

Scroll to navigation

Pod::Readme::Plugin::changes(3) User Contributed Perl Documentation Pod::Readme::Plugin::changes(3)

NAME

Pod::Readme::Plugin::changes - Include latest Changes in README

SYNOPSIS

  =for readme plugin changes

DESCRIPTION

This is a plugin for Pod::Readme that includes the latest release of a Changes file that conforms to the CPAN::Changes::Spec.

ARGUMENTS

Defaults can be overridden with optional arguments.

Note that changing arguments may change later calls to this plugin.

"file"

  =for readme plugin changes file='Changes'

If the Changes file has a non-standard name or location in the distribution, you can specify an alternative name. But note that it must conform the the CPAN::Changes::Spec.

"heading-level"

  =for readme plugin changes heading-level=1

This changes the heading level. (The default is 1.)

"title"

  =for readme plugin changes title='RECENT CHANGES'

This option allows you to change the title of the heading.

"verbatim"

  =for readme plugin changes verbatim

If you prefer, you can display a verbatim section of the Changes file.

By default, the Changes file will be parsed and reformatted as POD (equivalent to the "no-verbatim" option).

2019-04-03 perl v5.40.0