The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

BINGOS / Dist-Zilla-Plugin-AssertOS-0.08 / README 

            

              
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

              
NAME
    Dist::Zilla::Plugin::AssertOS - Require that our distribution is
    running on a particular OS
VERSION
    version 0.08
SYNOPSIS
      # In dist.ini - It is important that AssertOS follows MakeMaker or
      # ModuleBuild
     
      [MakeMaker]
     
      [AssertOS]
      os = Linux
      os = FreeBSD
      os = cygwin
    The resultant distribution will die at Makefile.PL unless the platform
    the code is running on is Linux, FreeBSD or Cygwin.
DESCRIPTION
    Dist::Zilla::Plugin::AssertOS is a Dist::Zilla plugin that integrates
    Devel::AssertOS so that CPAN authors may easily stipulate which
    particular OS environments their distributions may be built and
    installed on.
    The author specifies which OS or OS families are supported. The
    necessary Devel::AssertOS files are copied to the inc/ directory and
    Makefile.PL or Build.PL is mungled to include the necessary
    incantation.
    On the module user side, the bundled inc/ Devel::AssertOS determines
    whether the current environment is supported or not and will die
    accordingly.
    As this plugin mungles the Makefile.PL/Build.PL it is imperative that
    it is specified in dist.ini AFTER [MakeMaker] or [ModuleBuild].
    This plugin also automagically adds the no_index metadata so that inc/
    is excluded from PAUSE indexing. If you use
    Dist::Zilla::Plugin::MetaNoIndex, there may be conflicts.
 ATTRIBUTES
    os
      Specify as many times as wanted the OS that you wish your
      distribution to work with. See Devel::AssertOS and Devel::CheckOS for
      what may be given.
    bundle
      If set to c<0> Devel::AssertOS will not be bundled in the
      distribution. It will instead be added to configure_requires in the
      META files so CPAN clients can install it before running Makefile.PL.
      The default is 1, so Devel::AssertOS is bundled in inc.
 METHODS
    These are required by the roles that this plugin uses.
    mvp_multivalue_args
    gather_files
      Required by Dist::Zilla::Role::FileGatherer.
    setup_installer
      Required by Dist::Zilla::Role::InstallTool.
    metadata
      Required by Dist::Zilla::Role::MetaProvider.
KUDOS
    Based on use-devel-assertos by David Cantrell
    Build.PL support contributed by Yanick Champoux
    Thanks to Ricardo Signes, not only for Dist::Zilla, but for explaining
    Dist::Zilla::Role::InstallTool's place in the build process. This made
    this plugin possible.
SEE ALSO
    Dist::Zilla
    Devel::AssertOS
    Devel::CheckOS
AUTHOR
    Chris Williams <chris@bingosnet.co.uk>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2017 by Chris Williams and David
    Cantrell.
    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.