File: README.html

package info (click to toggle)
libdist-zilla-plugin-config-git-perl 0.92-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 204 kB
  • sloc: perl: 303; makefile: 2
file content (167 lines) | stat: -rw-r--r-- 5,124 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<html><head><title>Dist::Zilla::Plugin::Config::Git</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
</head>
<body class='pod'>
<!--
  generated by Pod::Simple::HTML v3.22,
  using Pod::Simple::PullParser v3.22,
  under Perl v5.014002 at Wed Dec  4 02:23:54 2013 GMT.

 If you want to change this HTML document, you probably shouldn't do that
   by changing it directly.  Instead, see about changing the calling options
   to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
   then reconverting this document from the Pod source.
   When in doubt, email the author of Pod::Simple::HTML for advice.
   See 'perldoc Pod::Simple::HTML' for more info.

-->

<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>

<h1><a class='u'
name="NAME"
>NAME</a></h1>

<p>Dist::Zilla::Plugin::Config::Git - Plugin configuration containing settings for a Git repo</p>

<h1><a class='u'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre>    [Config::Git / Git::main]
    remote        = origin
    local_branch  = master
    remote_branch = master
    allow_dirty   = dist.ini
    allow_dirty   = README
    allow_dirty   = qr{\w+\.ini}
    changelog     = Changes
 
    [Git::CheckFor::CorrectBranch]
    git_config = Git::main
 
    [@Git]
    git_config = Git::main
 
    ; etc.</pre>

<h1><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>This is a configuration plugin for Git repo/branch information. A configuration plugin is sort of like a Stash, but is better suited for intra-plugin data sharing, using distro (not user) data.</p>

<p>Why use this? To provide a standard set of information to other Git plugins easily, especially if the repo data is non-standard, or if you need more than one set of data.</p>

<h1><a class='u'
name="OPTIONS"
>OPTIONS</a></h1>

<h2><a class='u'
name="remote"
>remote</a></h2>

<p>Name of the remote repo, in standard Git repo format (refspec or git URL).</p>

<p>Default is <code>origin</code>.</p>

<h2><a class='u'
name="local_branch"
>local_branch</a></h2>

<p>Name of the local branch name.</p>

<p>Default is <code>master</code>.</p>

<h2><a class='u'
name="remote_branch"
>remote_branch</a></h2>

<p>Name of the remote branch name.</p>

<p>Default is <code>master</code>.</p>

<h2><a class='u'
name="allow_dirty"
>allow_dirty</a></h2>

<p>Filenames of files in the local repo that are allowed to have modifications prior to a write action, such as a commit. Multiple lines are allowed. Any strings in standard <code>qr</code> notation are interpreted as regular expressions.</p>

<p>Default is <code>dist.ini</code> and whatever <a href="http://search.cpan.org/perldoc?changelog" class="podlinkpod"
>changelog</a> is set to.</p>

<h2><a class='u'
name="changelog"
>changelog</a></h2>

<p>Name of your change log.</p>

<p>Default is <code>Changes</code>.</p>

<h1><a class='u'
name="ACKNOWLEDGEMENTS"
>ACKNOWLEDGEMENTS</a></h1>

<p>Kent Fredric and Karen Etheridge for implementation discussion. Graham Knop for continuous code reviews.</p>

<h1><a class='u'
name="AVAILABILITY"
>AVAILABILITY</a></h1>

<p>The project homepage is <a href="https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git" class="podlinkurl"
>https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git</a>.</p>

<p>The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <a href="http://www.perl.com/CPAN/" class="podlinkurl"
>http://www.perl.com/CPAN/</a> to find a CPAN site near you, or see <a href="https://metacpan.org/module/Dist::Zilla::Plugin::Config::Git/" class="podlinkurl"
>https://metacpan.org/module/Dist::Zilla::Plugin::Config::Git/</a>.</p>

<h1><a class='u'
name="SUPPORT"
>SUPPORT</a></h1>

<h2><a class='u'
name="Internet_Relay_Chat"
>Internet Relay Chat</a></h2>

<p>You can get live help by using IRC ( Internet Relay Chat ). If you don&#39;t know what IRC is, please read this excellent guide: <a href="http://en.wikipedia.org/wiki/Internet_Relay_Chat" class="podlinkurl"
>http://en.wikipedia.org/wiki/Internet_Relay_Chat</a>. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:</p>

<ul>
<li>irc.perl.org
<p>You can connect to the server at &#39;irc.perl.org&#39; and talk to this person for help: SineSwiper.</p>
</li>
</ul>

<h2><a class='u'
name="Bugs_/_Feature_Requests"
>Bugs / Feature Requests</a></h2>

<p>Please report any bugs or feature requests via <a href="https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues" class="podlinkurl"
>https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues</a>.</p>

<h1><a class='u'
name="AUTHOR"
>AUTHOR</a></h1>

<p>Brendan Byrd &#60;BBYRD@CPAN.org&#62;</p>

<h1><a class='u'
name="CONTRIBUTOR"
>CONTRIBUTOR</a></h1>

<p>Graham Knop &#60;haarg@haarg.org&#62;</p>

<h1><a class='u'
name="COPYRIGHT_AND_LICENSE"
>COPYRIGHT AND LICENSE</a></h1>

<p>This software is Copyright (c) 2013 by Brendan Byrd.</p>

<p>This is free software, licensed under:</p>

<pre>  The Artistic License 2.0 (GPL Compatible)</pre>

<!-- end doc -->

</body></html>