Diff of /FigKernelPackages/Tracer.pm

-revision 1.83, Fri Apr 27 22:13:57 2007 UTC
+revision 1.84, Thu May  3 12:28:00 2007 UTC
 Line 186
  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
  will be configured automatically.
+ NOTE: to configure emergency tracing from the command line instead of the Debugging
+ Control Panel (see below), use the C<trace.pl> script.
  =head3 Debugging Control Panel
  The debugging control panel provides several tools to assist in development of
-Line 445
+Line 448
                            noAlias => [0, "do not expect aliases in CHANGE transactions"],
                            start => [' ', "start with this genome"],
                            tblFiles => [0, "output TBL files containing the corrected IDs"] },
-                         "command transactionDirectory IDfile",
+                         "<command> <transactionDirectory> <IDfile>",
                        @ARGV);
-Line 457
+Line 460
      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
+ Single and double hyphens are equivalent. So, you could also code the
+ above command as
+     TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
  parameters, and would find themselves in I<@parameters> after executing the
  above code fragment. The tracing would be set to level 2, and the categories
-Line 491
+Line 499
  the tracing key is taken from the C<Tracing> environment variable. If there
  is no value for that variable, the tracing key will be computed from the PID.
- Finally, if the special option C<-h> is specified, the option names will
+ Finally, if the special option C<-help> is specified, the option
- be traced at level 0 and the program will exit without processing.
+ names will be traced at level 0 and the program will exit without processing.
  This provides a limited help capability. For example, if the user enters
-     TransactFeatures -h
+     TransactFeatures -help
  he would see the following output.
-     TransactFeatures [options] command transactionDirectory IDfile
+     TransactFeatures [options] <command> <transactionDirectory> <IDfile>
          -trace    tracing level (default E)
          -sql      trace SQL commands
          -safe     use database transactions
-Line 574
+Line 582
          $options->{trace} = ['E', "tracing level (E for emergency tracing)"];
      }
      $options->{sql} = [0, "turn on SQL tracing"];
-     $options->{h} = [0, "display command-line options"];
+     $options->{help} = [0, "display command-line options"];
      $options->{user} = [$tkey, "tracing key"];
      $options->{background} = [0, "spool standard and error output"];
      # Create a parsing hash from the options hash. The parsing hash
-Line 649
+Line 657
      }
      # Check for the "h" option. If it is specified, dump the command-line
      # options and exit the program.
-     if ($retOptions->{h}) {
+     if ($retOptions->{help}) {
          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
          print "$1 [options] $parmHelp\n";
          for my $key (sort keys %{$options}) {
-Line 1286
+Line 1294
  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>
- In this case, the list @words will be treated as a command line. There are two options available,
+ In this case, the list @words will be treated as a command line and there are two options available,
  B<errors> and B<logFile>. If @words has the following format
  C<< -logFile=error.log apple orange rutabaga >>
-Line 1300
+Line 1308
  C<< apple orange rutabaga >>
  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
- support for quote characters.
+ support for quote characters. Options can be specified with single or double hyphens.
  =over 4
-Line 1325
+Line 1333
      my ($optionTable, @inputList) = @_;
      # Process any options in the input list.
      my %overrides = ();
-     while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {
+     while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
          # Get the current option.
          my $arg = shift @inputList;
          # Pull out the option name.
-         $arg =~ /^-([^=]*)/g;
+         $arg =~ /^--?([^=]*)/g;
          my $name = $1;
          # Check for an option value.
          if ($arg =~ /\G=(.*)$/g) {
-Line 2290
+Line 2298
  This method converts an emergency tracing destination to a real
  tracing destination. The main difference is that if the
  destination is C<FILE> or C<APPEND>, we convert it to file
- output.
+ output. If the destination is C<DUAL>, we convert it to file
+ and standard output.
  =over 4
-Line 2320
+Line 2329
          $retVal = ">" . EmergencyFileTarget($tkey);
      } elsif ($myDest eq 'APPEND') {
          $retVal = ">>" . EmergencyFileTarget($tkey);
-     } else {
+     } elsif ($myDest eq 'DUAL') {
-         $retVal = $myDest;
+         $retVal = "+>" . EmergencyFileTarget($tkey);
      }
      # Return the result.
      return $retVal;
-Line 2331
+Line 2340
  C<< Emergency($key, $hours, $dest, $level, @modules); >>
- Turn on emergency tracing. This method can only be invoked over the web and is
+ Turn on emergency tracing. This method is normally invoked over the web from
- should not be called if debug mode is off. The caller specifies the duration of the
+ a debugging console, but it can also be called by the C<trace.pl> script.
- emergency in hours, the desired tracing destination, the trace level,
+ The caller specifies the duration of the emergency in hours, the desired tracing
- and a list of the trace modules to activate. For the length of the duration, when a
+ destination, the trace level, and a list of the trace modules to activate.
- program in an environment with the specified tracing key active invokes a Sprout
+ For the length of the duration, when a program in an environment with the
- CGI script, tracing will be turned on automatically. See L</TSetup> for more
+ specified tracing key active invokes a Sprout CGI script, tracing will be
- about tracing setup and L</ETracing> for more about emergency tracing.
+ turned on automatically. See L</TSetup> for more about tracing setup and
+ L</ETracing> for more about emergency tracing.
  =over 4

 Legend:



Removed from v.1.83
 


changed lines


 
Added in v.1.84
 Legend:



Removed from v.1.83
 


changed lines


 
Added in v.1.84
-Removed from v.1.83
+Added in v.1.84

MCS Webmaster	ViewVC Help
Powered by ViewVC 1.0.3