File: README

package info (click to toggle)
libdist-zilla-plugin-config-git-perl 0.92-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 204 kB
  • ctags: 5
  • sloc: perl: 303; makefile: 2
file content (104 lines) | stat: -rw-r--r-- 2,985 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
NAME
    Dist::Zilla::Plugin::Config::Git - Plugin configuration containing
    settings for a Git repo

SYNOPSIS
        [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.

DESCRIPTION
    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.

    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.

OPTIONS
  remote
    Name of the remote repo, in standard Git repo format (refspec or git
    URL).

    Default is "origin".

  local_branch
    Name of the local branch name.

    Default is "master".

  remote_branch
    Name of the remote branch name.

    Default is "master".

  allow_dirty
    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 "qr" notation are interpreted as
    regular expressions.

    Default is "dist.ini" and whatever changelog is set to.

  changelog
    Name of your change log.

    Default is "Changes".

ACKNOWLEDGEMENTS
    Kent Fredric and Karen Etheridge for implementation discussion. Graham
    Knop for continuous code reviews.

AVAILABILITY
    The project homepage is
    <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git>.

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

SUPPORT
  Internet Relay Chat
    You can get live help by using IRC ( Internet Relay Chat ). If you don't
    know what IRC is, please read this excellent guide:
    <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. 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:

    *   irc.perl.org

        You can connect to the server at 'irc.perl.org' and talk to this
        person for help: SineSwiper.

  Bugs / Feature Requests
    Please report any bugs or feature requests via
    <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues>.

AUTHOR
    Brendan Byrd <BBYRD@CPAN.org>

CONTRIBUTOR
    Graham Knop <haarg@haarg.org>

COPYRIGHT AND LICENSE
    This software is Copyright (c) 2013 by Brendan Byrd.

    This is free software, licensed under:

      The Artistic License 2.0 (GPL Compatible)