summaryrefslogtreecommitdiff
path: root/Master/tlpkg/TeXLive/TLUtils.pm
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-11-20 00:51:45 +0000
committerKarl Berry <karl@freefriends.org>2008-11-20 00:51:45 +0000
commit2a24c77658bca13466ce9fda66b318aa83458685 (patch)
tree9a5debbb4fedabbbe43a2d25bc45d0f122dc08e6 /Master/tlpkg/TeXLive/TLUtils.pm
parente3906837d6be0d574dcbf02b104aea9dc56fad5e (diff)
doc fixes.
git-svn-id: svn://tug.org/texlive/trunk@11363 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/TeXLive/TLUtils.pm')
-rw-r--r--Master/tlpkg/TeXLive/TLUtils.pm57
1 files changed, 41 insertions, 16 deletions
diff --git a/Master/tlpkg/TeXLive/TLUtils.pm b/Master/tlpkg/TeXLive/TLUtils.pm
index b3d328f5a44..a0d401c92bf 100644
--- a/Master/tlpkg/TeXLive/TLUtils.pm
+++ b/Master/tlpkg/TeXLive/TLUtils.pm
@@ -1599,6 +1599,10 @@ Write a debugging message, the concatenation of the argument strings.
The message will be omitted unless C<-v> was specified. If the log
file (see L<process_logging_options>) is defined, it also writes there.
+This first level debugging message reports on the overall flow of
+work, but does not include repeated messages about processing of each
+package.
+
=cut
sub debug {
@@ -1611,13 +1615,12 @@ sub debug {
=item C<ddebug ($str1, $str2, ...)>
Write a deep debugging message, the concatenation of the argument
-strings. The message will be omitted unless C<-v -v> was specified. If
-the log file (see L<process_logging_options>) is defined, it also writes
-there.
+strings. The message will be omitted unless C<-v -v> (or higher) was
+specified. If the log file (see L<process_logging_options>) is defined,
+it also writes there.
-This output is extremely voluminous; for example, every line of input
-when reading the TeX Live Database is reported. It includes everything
-we ever found useful when debugging.
+This second level debugging message reports messages about processing
+each package, in addition to the first level.
=cut
@@ -1626,6 +1629,17 @@ sub ddebug {
logit(\*STDOUT, 2, "DD:", @_);
}
+=item C<dddebug ($str1, $str2, ...)>
+
+Write the deepest debugging message, the concatenation of the argument
+strings. The message will be omitted unless C<-v -v -v> was specified.
+If the log file (see L<process_logging_options>) is defined, it also
+writes there.
+
+This third level debugging message reports messages about processing
+each line of any tlpdb files read, in addition to the first and second
+levels.
+
sub dddebug {
return if ($::opt_verbosity < 3);
logit(\*STDOUT, 3, "DDD:", @_);
@@ -1709,16 +1723,24 @@ Omit normal informational messages.
=item B<-v>
-Include debugging messages; repeat for maximum debugging, as in C<-v
--v> or C<-vv>. Further repeats of C<-v>, as in C<-v -v -v>, are accepted but
-ignored. C<-vvv> is an error.
+Include debugging messages. With one C<-v>, reports overall flow; with
+C<-v -v> (or C<-vv>), also reports per-package processing; with C<-v -v
+-v> (or C<-vvv>), also reports each line read from any tlpdb files.
+Further repeats of C<-v>, as in C<-v -v -v -v>, are accepted but
+ignored. C<-vvvv> is an error.
+
+The idea behind these levels is to be able to specify C<-v> to get an
+overall idea of what is going on, but avoid terribly voluminous output
+when processing many packages, as we often are. When debugging a
+specific problem with a specific package, C<-vv> can help. When
+debugging problems with parsing tlpdb files, C<-vvv> gives that too.
=item B<-logfile> I<file>
-Write both all messages (informational, debugging, warnings) to I<file>,
-in addition to standard output or standard error. In TeX Live, only the
-installer sets a log file by default, none of other the standard TeX
-Live scripts use this feature.
+Write all messages (informational, debugging, warnings) to I<file>, in
+addition to standard output or standard error. In TeX Live, only the
+installer sets a log file by default; none of the other standard TeX
+Live scripts use this feature, but you can specify it explicitly.
=back
@@ -1732,17 +1754,20 @@ sub process_logging_options {
$::opt_quiet = 0;
my $opt_logfile;
my $opt_Verbosity = 0;
+ my $opt_VERBOSITY = 0;
# check all the command line options for occurrences of -q and -v;
# do not report errors.
my $oldconfig = Getopt::Long::Configure(qw(pass_through permute));
GetOptions("logfile=s" => \$opt_logfile,
- "v+" => \$::opt_verbosity,
- "vv" => \$opt_Verbosity,
- "q" => \$::opt_quiet);
+ "v+" => \$::opt_verbosity,
+ "vv" => \$opt_Verbosity,
+ "vvv" => \$opt_VERBOSITY,
+ "q" => \$::opt_quiet);
Getopt::Long::Configure($oldconfig);
# verbosity level, forcing -v -v instead of -vv is too annoying.
$::opt_verbosity = 2 if $opt_Verbosity;
+ $::opt_verbosity = 3 if $opt_VERBOSITY;
# open log file if one was requested.
if ($opt_logfile) {