1Dist::Zilla::Role::Git:U:sDeirrtCyoFnitlreisb(u3t)ed PerDlisDto:c:uZmielnltaa:t:iRoonle::Git::DirtyFiles(3)
2
3
4

NAME

6       Dist::Zilla::Role::Git::DirtyFiles - Provide the allow_dirty &
7       changelog attributes
8

VERSION

10       version 2.047
11

DESCRIPTION

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

ATTRIBUTES

17   allow_dirty
18       A list of paths that are allowed to be dirty in the git checkout.
19       Defaults to "dist.ini" and the changelog (as defined per the
20       "changelog" attribute.
21
22       If your "repo_root" is not the default ("."), then these pathnames are
23       relative to Dist::Zilla's root directory, not the Git root directory.
24
25   allow_dirty_match
26       A list of regular expressions that match paths allowed to be dirty in
27       the git checkout.  This is combined with "allow_dirty".  Defaults to
28       the empty list.
29
30       The paths being matched are relative to the Git root directory, even if
31       your "repo_root" is not the default (".").
32
33   changelog
34       The name of the changelog. Defaults to "Changes".
35

METHODS

37   list_dirty_files
38         my @dirty = $plugin->list_dirty_files($git, $listAllowed);
39
40       This returns a list of the modified or deleted files in $git, filtered
41       against the "allow_dirty" attribute.  If $listAllowed is true, only
42       allowed files are listed.  If it's false, only files that are not
43       allowed to be dirty are listed.
44
45       In scalar context, returns the number of dirty files.
46

SUPPORT

48       Bugs may be submitted through the RT bug tracker
49       <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
50       Git> (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org <mailto:bug-Dist-Zilla-
51       Plugin-Git@rt.cpan.org>).
52
53       There is also a mailing list available for users of this distribution,
54       at <http://dzil.org/#mailing-list>.
55
56       There is also an irc channel available for users of this distribution,
57       at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
58

AUTHOR

60       Jerome Quelin
61

63       This software is copyright (c) 2009 by Jerome Quelin.
64
65       This is free software; you can redistribute it and/or modify it under
66       the same terms as the Perl 5 programming language system itself.
67
68
69
70perl v5.32.0                      2020-09-D1i4st::Zilla::Role::Git::DirtyFiles(3)
Impressum