/ 
Dist-Zilla-Plugin-Mercurial-0.02
River stage one • 1 direct dependent • 1 total dependent
/ Dist::Zilla::Role::Mercurial::DirtyFiles

NAME

Dist::Zilla::Role::Mercurial::DirtyFiles - provide the allow_dirty & changelog attributes

VERSION

version 0.02

DESCRIPTION

This role is used within the git plugin to work with files that are dirty in the local git checkout.

ATTRIBUTES

allow_dirty

A list of files that are allowed to be dirty in the git checkout. Defaults to dist.ini and the changelog (as defined per the changelog attribute.

changelog

The name of the changelog. Defaults to Changes.

METHODS

list_dirty_files

my @dirty = $plugin->list_dirty_files($git, $listAllowed);

This returns a list of the modified or deleted files in $git, filtered against the allow_dirty attribute. If $listAllowed is true, only allowed files are listed. If it's false, only files that are not allowed to be dirty are listed.

In scalar context, returns the number of dirty files.

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Dave Rolsky.

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