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
|
.\" -*- 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 "CPAN::Kwalify 3pm"
.TH CPAN::Kwalify 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
CPAN::Kwalify \- Interface between CPAN.pm and Kwalify.pm
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use CPAN::Kwalify;
\& validate($schema_name, $data, $file, $doc);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.ie n .IP "_validate($schema_name, $data, $file, $doc)" 4
.el .IP "_validate($schema_name, \f(CW$data\fR, \f(CW$file\fR, \f(CW$doc\fR)" 4
.IX Item "_validate($schema_name, $data, $file, $doc)"
\&\f(CW$schema_name\fR is the name of a supported schema. Currently only
\&\f(CW\*(C`distroprefs\*(C'\fR is supported. \f(CW$data\fR is the data to be validated. \f(CW$file\fR
is the absolute path to the file the data are coming from. \f(CW$doc\fR is the
index of the document within \f(CW$doc\fR that is to be validated. The last
two arguments are only there for better error reporting.
.Sp
Relies on being called from within CPAN.pm.
.Sp
Dies if something fails. Does not return anything useful.
.IP yaml($schema_name) 4
.IX Item "yaml($schema_name)"
Returns the YAML text of that schema. Dies if something fails.
.SH AUTHOR
.IX Header "AUTHOR"
Andreas Koenig \f(CW\*(C`<andk@cpan.org>\*(C'\fR
.SH LICENSE
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>
|
