summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm')
-rw-r--r--upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm132
1 files changed, 132 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm b/upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm
new file mode 100644
index 00000000..313a823f
--- /dev/null
+++ b/upstream/mageia-cauldron/man3pm/CPAN::Meta::Validator.3pm
@@ -0,0 +1,132 @@
+.\" -*- 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::Meta::Validator 3pm"
+.TH CPAN::Meta::Validator 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::Meta::Validator \- validate CPAN distribution metadata structures
+.SH VERSION
+.IX Header "VERSION"
+version 2.150010
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& my $struct = decode_json_file(\*(AqMETA.json\*(Aq);
+\&
+\& my $cmv = CPAN::Meta::Validator\->new( $struct );
+\&
+\& unless ( $cmv\->is_valid ) {
+\& my $msg = "Invalid META structure. Errors found:\en";
+\& $msg .= join( "\en", $cmv\->errors );
+\& die $msg;
+\& }
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+This module validates a CPAN Meta structure against the version of the
+the specification claimed in the \f(CW\*(C`meta\-spec\*(C'\fR field of the structure.
+.SH METHODS
+.IX Header "METHODS"
+.SS new
+.IX Subsection "new"
+.Vb 1
+\& my $cmv = CPAN::Meta::Validator\->new( $struct )
+.Ve
+.PP
+The constructor must be passed a metadata structure.
+.SS is_valid
+.IX Subsection "is_valid"
+.Vb 3
+\& if ( $cmv\->is_valid ) {
+\& ...
+\& }
+.Ve
+.PP
+Returns a boolean value indicating whether the metadata provided
+is valid.
+.SS errors
+.IX Subsection "errors"
+.Vb 1
+\& warn( join "\en", $cmv\->errors );
+.Ve
+.PP
+Returns a list of errors seen during validation.
+.SH BUGS
+.IX Header "BUGS"
+Please report any bugs or feature using the CPAN Request Tracker.
+Bugs can be submitted through the web interface at
+<http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
+.PP
+When submitting a bug or request, please include a test-file or a patch to an
+existing test-file that illustrates the bug or desired feature.
+.SH AUTHORS
+.IX Header "AUTHORS"
+.IP \(bu 4
+David Golden <dagolden@cpan.org>
+.IP \(bu 4
+Ricardo Signes <rjbs@cpan.org>
+.IP \(bu 4
+Adam Kennedy <adamk@cpan.org>
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
+.PP
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.