.\" -*- 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::Repo 3pm"
.TH Dist::Zilla::Role::Git::Repo 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::Repo \- Provide repository information for Git plugins
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This role is used within the Git plugins to get information about the
repository structure, and to create a Git::Wrapper object.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS repo_root
.IX Subsection "repo_root"
The repository root, either as a full path or relative to the distribution
root. The default is the distribution root (\f(CW\*(C`$zilla\-\*(C'\fRroot>).
.SH METHODS
.IX Header "METHODS"
.SS current_git_branch
.IX Subsection "current_git_branch"
.Vb 1
\&  $branch = $plugin\->current_git_branch;
.Ve
.PP
The current branch in the repository, or \f(CW\*(C`undef\*(C'\fR if the repository
has a detached HEAD.  Note: This value is cached; it will not
be updated if the branch is changed during the run.
.SS git
.IX Subsection "git"
.Vb 1
\&  $git = $plugin\->git;
.Ve
.PP
This method returns a Git::Wrapper object for the \f(CW\*(C`repo_root\*(C'\fR
directory, constructing one if necessary.  The object is shared
between all plugins that consume this role (if they have the same
\&\f(CW\*(C`repo_root\*(C'\fR).
.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.