Sfoglia il codice sorgente

t: Mark partially documented POD modules as TODO

This makes sure we will not forget to get them out of the ignore list
once they get documented.
Guillem Jover 10 anni fa
parent
commit
429bd8f096
2 ha cambiato i file con 18 aggiunte e 5 eliminazioni
  1. 4 0
      debian/changelog
  2. 14 5
      t/pod-coverage.t

+ 4 - 0
debian/changelog

@@ -1,5 +1,9 @@
 dpkg (1.18.15) UNRELEASED; urgency=medium
 
+  [ Guillem Jover ]
+  * Test suite:
+    - Mark partially documented POD modules as TAP TODO.
+
   [ Updated man pages translations ]
   * German (Helge Kreutzmann).
 

+ 14 - 5
t/pod-coverage.t

@@ -17,6 +17,7 @@ use strict;
 use warnings;
 
 use File::Find;
+use Dpkg::Util qw(any);
 
 use Test::More;
 use Test::Dpkg qw(:needs);
@@ -27,6 +28,7 @@ test_needs_srcdir_switch();
 
 sub all_pod_modules
 {
+    my @modules_todo = @_;
     my @modules;
     my $scan_perl_modules = sub {
         my $module = $File::Find::name;
@@ -41,9 +43,7 @@ sub all_pod_modules
         $module =~ s{^\Q$File::Find::topdir\E/}{};
         $module =~ s{/}{::}g;
 
-        # Do not check partially private modules.
-        return if $module eq 'Dpkg::Arch';
-        return if $module eq 'Dpkg::Source::Package';
+        return if any { $module eq $_ } @modules_todo;
 
         push @modules, $module;
     };
@@ -57,10 +57,19 @@ sub all_pod_modules
     return @modules;
 }
 
-my @modules = all_pod_modules();
+my @modules_todo = qw(Dpkg::Arch Dpkg::Source::Package);
+my @modules = all_pod_modules(@modules_todo);
 
-plan tests => scalar @modules;
+plan tests => scalar @modules + scalar @modules_todo;
 
 for my $module (@modules) {
     pod_coverage_ok($module);
 }
+
+TODO: {
+    local $TODO = 'modules partially documented';
+
+    for my $module (@modules_todo) {
+        pod_coverage_ok($module);
+    }
+}