.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Role::Git::DirtyFiles 3pm"
.TH Dist::Zilla::Role::Git::DirtyFiles 3pm 2024-01-20 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Dist::Zilla::Role::Git::DirtyFiles \- Provide the allow_dirty & changelog attributes
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This role is used within the git plugin to work with files that are
dirty in the local git checkout.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS allow_dirty
.IX Subsection "allow_dirty"
A list of paths that are allowed to be dirty in the git checkout.
Defaults to \f(CW\*(C`dist.ini\*(C'\fR and the changelog (as defined per the
\&\f(CW\*(C`changelog\*(C'\fR attribute.
.PP
If your \f(CW\*(C`repo_root\*(C'\fR is not the default (\f(CW\*(C`.\*(C'\fR), then these pathnames
are relative to Dist::Zilla's root directory, not the Git root directory.
.SS allow_dirty_match
.IX Subsection "allow_dirty_match"
A list of regular expressions that match paths allowed to be dirty in
the git checkout.  This is combined with \f(CW\*(C`allow_dirty\*(C'\fR.  Defaults to
the empty list.
.PP
The paths being matched are relative to the Git root directory, even
if your \f(CW\*(C`repo_root\*(C'\fR is not the default (\f(CW\*(C`.\*(C'\fR).
.SS changelog
.IX Subsection "changelog"
The name of the changelog. Defaults to \f(CW\*(C`Changes\*(C'\fR.
.SH METHODS
.IX Header "METHODS"
.SS list_dirty_files
.IX Subsection "list_dirty_files"
.Vb 1
\&  my @dirty = $plugin\->list_dirty_files($git, $listAllowed);
.Ve
.PP
This returns a list of the modified or deleted files in \f(CW$git\fR,
filtered against the \f(CW\*(C`allow_dirty\*(C'\fR attribute.  If \f(CW$listAllowed\fR is
true, only allowed files are listed.  If it's false, only files that
are not allowed to be dirty are listed.
.PP
In scalar context, returns the number of dirty files.
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Git>
(or bug\-Dist\-Zilla\-Plugin\-Git@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Git@rt.cpan.org>).
.PP
There is also a mailing list available for users of this distribution, at
<http://dzil.org/#mailing\-list>.
.PP
There is also an irc channel available for users of this distribution, at
\&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR <irc://irc.perl.org/#distzilla>.
.SH AUTHOR
.IX Header "AUTHOR"
Jerome Quelin
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2009 by Jerome Quelin.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.