[project @ 2005-03-16 19:53:49 by cjwatson]

[debbugs.git] / Debbugs / Log.pm
diff --git a/Debbugs/Log.pm b/Debbugs/Log.pm

index f52904a0e3371a5b8bab544487497b01c5000106..5889fdc6c384e0c07e7befb4feaa0b7f462b3324 100644 (file)
--- a/Debbugs/Log.pm
+++ b/Debbugs/Log.pm
@@ -35,8 +35,8 @@ types. ^A, ^B, etc. represent those control characters.
    [mail]
    ^C
  
-[mail] must start with /^Received: \(at \S+\) by \S+;/, and is copied to the
-output.
+C<[mail]> must start with /^Received: \(at \S+\) by \S+;/, and is copied to
+the output.
  
  =item autocheck
  
@@ -74,17 +74,21 @@ of the message itself.
  [html] is copied unescaped to the output. The record immediately following
  this one is considered "boring" and only shown in certain output modes.
  
-No other types of records are permitted, and the file must end with a ^C
-line.
+(This is a design flaw in the log format, since it makes it difficult to
+change the HTML presentation later, or to present the data in an entirely
+different format.)
  
  =back
  
+No other types of records are permitted, and the file must end with a ^C
+line.
+
  =head2 Perl Record Representation
  
  Each record is a hash. The C<type> field is C<incoming-recv>, C<autocheck>,
-C<recips>, or C<html> as above; C<mail> and C<html> contain text as above;
-C<recips> is a reference to an array of recipients (strings), or undef for
-C<-t>.
+C<recips>, or C<html> as above; C<text> contains text from C<[mail]> or
+C<[html]> as above; C<recips> is a reference to an array of recipients
+(strings), or undef for C<-t>.
  
  =head1 FUNCTIONS
  
@@ -229,6 +233,8 @@ sub write_log_records (*@)
      1;
  }
  
+=back
+
  =head1 CAVEATS
  
  This module does none of the formatting that bugreport.cgi et al do. It's