keep_catalogue = 0 by default, doc fixes.

git-svn-id: svn://tug.org/texlive/trunk@26657 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 52 insertions, 50 deletions

diff --git a/Master/tlpkg/bin/tl-update-tlpdb b/Master/tlpkg/bin/tl-update-tlpdb
index 1dd4fcf683f..5c5f9f67541 100755
--- a/Master/tlpkg/bin/tl-update-tlpdb
+++ b/Master/tlpkg/bin/tl-update-tlpdb
@@ -2,7 +2,7 @@
 # $Id$
 # convert a set of tlpsrc files (given as arguments) into tlpdb
 # 
-# Copyright 2007, 2008, 2009, 2010 Norbert Preining
+# Copyright 2007-2012 Norbert Preining
 # This file is licensed under the GNU General Public License version 2
 # or any later version.
 
@@ -40,7 +40,7 @@ my $opt_tlpsrc_from_cmdline = 0;
 my $opt_w32warning;
 my $opt_tlpdb_options_from_tlpsrc = 0;
 my $opt_keep_revisions = 0;
-my $opt_keep_catalogue = 1;
+my $opt_keep_catalogue = 0;
 
 TeXLive::TLUtils::process_logging_options();
 GetOptions(
@@ -67,8 +67,7 @@ my $progname = TeXLive::TLUtils::basename($0);
 exit (&main ());
 
 
-sub main
-{
+sub main {
   if (! -d $opt_master) {
     die "$progname: Master $opt_master not a directory, goodbye.\n";
   }
@@ -89,7 +88,8 @@ sub main
       require($opt_catalogue);
       #$tlc = TeXLive::TeXCatalogue->new ("location" => $opt_catalogue);
     } else {
-      tlwarn("$progname: Cannot find $opt_catalogue, reuse old data!\n");
+      tlwarn("$progname: reusing Catalogue data, since file not readable: "
+             . "$opt_catalogue\n");
       $opt_keep_catalogue = 1;
     }
   } else {
@@ -176,8 +176,7 @@ sub main
 }
 
 
-sub move_revisions_over
-{
+sub move_revisions_over {
   my ($oldtlpdb, $newtlpdb) = @_;
   for my $pkg ($newtlpdb->list_packages) {
     my $oldtlp = $oldtlpdb->get_package($pkg);
@@ -188,8 +187,7 @@ sub move_revisions_over
 }
 
 
-sub move_catalogue_over
-{
+sub move_catalogue_over {
   # not working at the moment, the catalogue hash needs to be moved
   # one by one!
   my ($oldtlpdb, $newtlpdb) = @_;
@@ -206,8 +204,7 @@ sub move_catalogue_over
 }
 
 
-sub compare_and_fix_tlpdbs
-{
+sub compare_and_fix_tlpdbs {
   my ($oldtlpdb, $newtlpdb) = @_;
 
   my %ret = TeXLive::TLUtils::compare_tlpdbs($oldtlpdb, $newtlpdb);
@@ -323,8 +320,7 @@ sub compare_and_fix_tlpdbs
 }
 
 
-sub create_tlpdb
-{
+sub create_tlpdb {
   my ($tlc) = @_;
   
   if (defined($opt_w32warning)) {
@@ -448,8 +444,7 @@ sub create_tlpdb
 
 
 
-sub finish
-{
+sub finish {
   my ($tlpdb,$pkgcount) = @_;
   if ($opt_output) {
     if (open(OUT, ">$opt_output")) {
@@ -479,82 +474,89 @@ tl-update-tlpdb [OPTION]... [TLPSRC]...
 
 =over 4
 
-=item B<-catalogue> I<Catalogue_dir>
+=item B<--catalogue> I<Catalogue_file>
 
-The location given by B<-catalogue> must point to a valid TeX Catalogue
-directory (with subdirectory C<entries>).  No default value.  If given,
-the generated tlpobj files will contain information gathered from the
-TeX Catalogue.
+The I<Catalogue_file> must point to a valid TeX Catalogue as a Perl data
+dump; default is C<Master/texmf/scripts/texlive/var/texcatalogue.data>,
+where C<Master> is the master directory described below.  That file is
+update nightly by the C<tl-update-auto> script.  If this file is given
+and readable, the generated tlpobj files will contain information
+gathered from the TeX Catalogue.
 
-=item B<-fix-reverse-revisions>
+=item B<--fix-reverse-revisions>
 
 If a package with revisions going backward is found, this option makes
-C<tl-update-tlpdb> try to check in some dummy changes to the package's
+C<tl-update-tlpdb> try to check in a dummy change to the package's
 tlpsrc file to artificially increase the version number.
 
-=item B<-from-files>
+=item B<--from-files>
 
 Use C<find> instead of C<svn -status> to create the list of files.
 
-=item B<-master> I<Master/dir>
+=item B<--master> I<Master_dir>
 
 The location I<Master/dir> must point to a valid svn repository of TeX
 Live's Master directory.  Defaults to C<../..> of C<$0>.
 
-=item B<-no-bin-split>
+=item B<-n>, B<--dry-run>
+
+Don't make permanent changes: same as C<--no-commit> and
+C<--no-reverse-revision-check>, plus output to the C</tmp/tlut> (if no
+C<--output> file is given) rather than updating the current tlpdb.
+
+=item B<--no-bin-split>
 
 Do NOT split files with binaries into several packages (one for the arch
 independent and one for each of the architectures with only the respective
 binaries).  There is no reason to use this option.
 
-=item B<-no-commit>
+=item B<--no-commit>
 
 If changes have been made to the tlpsrc files (because reversed
-revisions have been found and C<-fix-reverse-revisions> was given) these
-changes will by default committed using C<svn commit> on the tlpsrc
-directory.  With this option the commit step is skipped.
+revisions have been found and C<--fix-reverse-revisions> is enabled)
+these changes will by default be committed using C<svn commit> on the
+tlpsrc directory.  With this option the commit step is skipped.
 
-=item B<-no-reverse-revision-check>
+=item B<--no-reverse-revision-check>
 
 By default, C<tl-update-tlpdb> checks that in the generated tlpdb the
 revision numbers of packages are not going backward compared to the
 previous version. This option disables this check.
 
-=item B<-output=filename>
+=item B<--output=filename>
 
-By default, B<tl-update-tlpdb> saves/updates the tlpdb in the default
-place. This option specifies the place where the output should go to.
+By default, C<tl-update-tlpdb> saves/updates the tlpdb in the default
+place.  This option specifies the place where the output should go to.
 
-=item B<-save-anyway>
+=item B<--save-anyway>
 
 If the newly created tlpdb is in considered buggy due to reversed
 revisions it will normally not be saved. This switch allows saving it
-anyway. It can be useful in combination with the C<-from-files> option
+anyway. It can be useful in combination with the C<--from-files> option
 where the revision numbers will be adjusted afterwards by an external
 program.
 
-=item B<-tlpsrc-from-cmdline>
+=item B<--tlpdb-options-from-tlpsrc>
+
+By default, the tlpdb specific settings in C<00texlive.config> are taken
+from the C<%TeXLive::TLConfig::TLPDBConfigs>.  Alternative repositories
+might set these values directly in the tlpsrc file; using this option
+omits adding anything to the configs set in the tlpsrc file.
 
-By default, B<tl-update-tlpdb> recreates the tlpdb from all the tlpsrc
+=item B<--tlpsrc-from-cmdline>
+
+By default, C<tl-update-tlpdb> recreates the tlpdb from all the tlpsrc
 files present in the current tree.  If this option is given, the tlpsrc
-have to be given on the command line.  If you're trying to debug the
-conversion of one particular package, this is the option to use.
+file(s) have to be given on the command line.  If you're trying to debug
+the conversion of one particular package, this is the option to use.
 
-=item B<-with-w32-pattern-warning>
+=item B<--with-w32-pattern-warning>
 
 Normally, this program issues a warning for patterns without a matching
 file, with the exception that it does I<not> warn for binpatterns
 related to Windows. Giving this option makes it issue all warnings,
 i.e., also those where a W32-related binpattern does not hit.
 
-=item B<-tlpdb-options-from-tlpsrc>
-
-By default the tlpdb specific settings in 00texlive.config are taken from
-the C<%TeXLive::TLConfig::TLPDBConfigs>. Alternative repositories might
-set these values directly in the tlpsrc file. Using 
-B<-tlpdb-options-from-tlpsrc> overrides the default behaviour and does
-not add anything to the configs set in the tlpsrc file.
-
 =back
 
 The standard options C<-q>, C<-v>, and C<-logfile>=I<file> are also
@@ -574,8 +576,8 @@ made.  In this case it commits a dummy change to the package's tlpsrc
 file to make sure that revisions are always increasing.
 
 If a TeX Catalogue hierarchy is specified, additional information from
-the catalogue are merged into the database (see L<TeXLive::TLPOBJ> for
-the list of included information from the TeX Catalogue).
+the Catalogue is merged into the database (see L<TeXLive::TLPOBJ> for
+the specifics).
 
 =head1 AUTHORS AND COPYRIGHT