add doc

3 files changed, 61 insertions, 1 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>
diff --git a/lib/Config/Model/models/Dpkg.pl b/lib/Config/Model/models/Dpkg.pl
index d3ff8507..e1f62609 100644
--- a/lib/Config/Model/models/Dpkg.pl
+++ b/lib/Config/Model/models/Dpkg.pl
@@ -182,7 +182,12 @@ plain C<lintian-overrides> is contained in "." element.
 
 Other files are contained in basename element.
 
-For instance, C<debian/foo.lintian-overrides> is contained in C<foo> element.',
+For instance, C<debian/foo.lintian-overrides> is contained in C<foo> element.
+
+Unknown L<lintian tags| https://lintian.debian.org/tags.html> trigger a warning.
+
+
+',
         'index_type' => 'string',
         'type' => 'hash'
       },
diff --git a/lib/Config/Model/models/Dpkg/Source.pl b/lib/Config/Model/models/Dpkg/Source.pl
index 436be3ca..455c1bfa 100644
--- a/lib/Config/Model/models/Dpkg/Source.pl
+++ b/lib/Config/Model/models/Dpkg/Source.pl
@@ -50,6 +50,18 @@ There may also be a .git shallow file listing revisions for a shallow git clone.
       'lintian-overrides',
       {
         'class' => 'Config::Model::Dpkg::Lintian::Overrides',
+        'description' => 'Contains the lintian overrides parameters from all lintian overrides files contained in C<debian/*lintian-overrides>.
+
+plain C<lintian-overrides> is contained in "." element.
+
+Other files are contained in basename element.
+
+For instance, C<debian/foo.lintian-overrides> is contained in C<foo> element.
+
+Unknown L<lintian tags| https://lintian.debian.org/tags.html> trigger a warning.
+
+
+',
         'type' => 'leaf',
         'value_type' => 'string'
       }