add doc

1 files changed, 43 insertions, 0 deletions

diff --git a/lib/Config/Model/Dpkg/Lintian/Overrides.pm b/lib/Config/Model/Dpkg/Lintian/Overrides.pm
index 11579501..74881e93 100644
--- a/lib/Config/Model/Dpkg/Lintian/Overrides.pm
+++ b/lib/Config/Model/Dpkg/Lintian/Overrides.pm
@@ -95,3 +95,46 @@ around _check_value => sub ( $orig, $self, %args ) {
 };
 
 1;
+
+__END__
+
+=head1 NAME
+
+Config::Model::Dpkg::Lintian::Overrides - Checks lintian-overrides file
+
+=head1 SYNOPSIS
+
+No synopsis. This class is to be used by Dpkg model.
+
+=head1 DESCRIPTION
+
+This class is derived from L<Config::Model::Value>. Its purpose is to
+check the content of C<debian/*lintian-overrides> and
+C<debian/source/lintian-overrides> files.
+
+Only the validity of the tags are checked. They are compared to the list of tags
+shipped in lintian package.
+
+Unknown or obsolete tags trigger a warning.
+
+Obsolete tags can be replaced with their new name with C<cme fix dpkg>.
+
+=head1 Limitations
+
+=over
+
+=item *
+
+Syntax of lintian-overrides is not checked.
+
+=back
+
+=head1 AUTHOR
+
+Dominique Dumont, ddumont [AT] cpan [DOT] org
+
+=head1 SEE ALSO
+
+L<Config::Model>,
+L<Config::Model::Value>,
+L<lintian>