1Test::CheckManifest(3)User Contributed Perl DocumentationTest::CheckManifest(3)
2
3
4

NAME

6       Test::CheckManifest
7

VERSION

9       version 1.24
10

SYNOPSIS

12         use Test::CheckManifest;
13         ok_manifest();
14

DESCRIPTION

16       "Test::CheckManifest"
17
18   EXPORT
19       There is only one method exported: "ok_manifest"
20

NAME

22       Test::CheckManifest - Check if your Manifest matches your distro
23

METHODS

25   ok_manifest   [{exlude => $arref}][$msg]
26       checks whether the Manifest file matches the distro or not. To match a
27       distro the Manifest has to name all files that come along with the
28       distribution.
29
30       To check the Manifest file, this module searches for a file named
31       "MANIFEST".
32
33       To exclude some directories from this test, you can specify these dirs
34       in the hashref.
35
36         ok_manifest({exclude => ['/var/test/']});
37
38       is ok if the files in "/path/to/your/dist/var/test/" are not named in
39       the "MANIFEST" file. That means that the paths in the exclude array
40       must be "pseudo-absolute" (absolute to your distribution).
41
42       To use a "filter" you can use the key "filter"
43
44         ok_manifest({filter => [qr/\.svn/]});
45
46       With that you can exclude all files with an '.svn' in the filename or
47       in the path from the test.
48
49       These files would be excluded (as examples):
50
51       ·   /dist/var/.svn/test
52
53       ·   /dist/lib/test.svn
54
55       You can also combine "filter" and "exclude" with 'and' or 'or' default
56       is 'or':
57
58         ok_manifest({exclude => ['/var/test'],
59                      filter  => [qr/\.svn/],
60                      bool    => 'and'});
61
62       These files have to be named in the "MANIFEST":
63
64       ·   /var/foo/.svn/any.file
65
66       ·   /dist/t/file.svn
67
68       ·   /var/test/test.txt
69
70       These files not:
71
72       ·   /var/test/.svn/*
73
74       ·   /var/test/file.svn
75

EXCLUDING FILES

77       Beside "filter" and "exclude" there is another way to exclude files:
78       "MANIFEST.SKIP". This is a file with filenames that should be excluded:
79
80         t/my_very_own.t
81         file_to.skip
82

ACKNOWLEDGEMENT

84       Great thanks to Christopher H. Laco, who did a lot of testing stuff for
85       me and he reported some bugs to RT.
86

AUTHOR

88       Renee Baecker, <module@renee-baecker.de>
89

91       Copyright (C) 2006 - 2011 by Renee Baecker
92
93       This library is free software; you can redistribute it and/or modify it
94       under the same terms as Artistic License 2.0
95

AUTHOR

97       Renee Baecker <module@renee-baecker.de>
98

100       This software is Copyright (c) 2011 by Renee Baecker.
101
102       This is free software, licensed under:
103
104         The Artistic License 2.0
105
106
107
108perl v5.12.3                      2011-04-09            Test::CheckManifest(3)
Impressum