tap: improve some comments in the TAP driver

* lib/tap-driver (handle_tap_plan): Improve comments describing
possible errors in a "plan with SKIP" directive.

diff --git a/ChangeLog b/ChangeLog
index 9a1d6011edb6184a9d2798a6bf8bf4acabcd22a0..d346d05a268e4607de91b9f89ed32de0e50e040f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-08-12  Stefano Lattarini  <stefano.lattarini@gmail.com>
+
+       tap: improve some comments in the TAP driver
+       * lib/tap-driver (handle_tap_plan): Improve comments describing
+       possible errors in a "plan with SKIP" directive.
+
 2011-08-12  Stefano Lattarini  <stefano.lattarini@gmail.com>
 
        tap: non-zero exit status after "Bail out!" should not be reported

diff --git a/lib/tap-driver b/lib/tap-driver
index b7a8ffbe33c5e99fbb7810a7b652c648458eb355..0f4eb84d4bca7502c06fc4554c929d71d4142bcc 100755 (executable)
--- a/lib/tap-driver
+++ b/lib/tap-driver
@@ -369,12 +369,12 @@ sub handle_tap_plan ($)
   # So, if we find it after having already seen at least one TAP result,
   # set a flag signaling that no more TAP results are acceptable.
   $tap_stopped = 1 if $testno >= 1;
-  # If the plan contains a SKIP directive, and it's not an error, we
-  # want to report it as a particular kind of SKIP result.
-  # If "$testno > 0", we have is an error that will be automatically
-  # dealt with later, so don't worry about it here.
-  # If "$plan_seen" is true, we have an error due to a repeated plan,
-  # and that has already been dealt with above.
+  # If $testno > 0, we have an error ("too many tests run") that will be
+  # automatically dealt with later, so don't worry about it here.  If
+  # $plan_seen is true, we have an error due to a repeated plan, and that
+  # has already been dealt with above.  Otherwise, we have a valid "plan
+  # with SKIP" specification, and should report it as a particular kind
+  # of SKIP result.
   if ($plan->directive && $testno == 0 && !$plan_seen)
     {
       my $explanation = $plan->explanation ?