diff options
author | Karl Berry <karl@freefriends.org> | 2008-12-24 19:49:28 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2008-12-24 19:49:28 +0000 |
commit | 4d5b0d9afc48f2d8e9ae1e3198a4b9adf142deae (patch) | |
tree | 843cd3647fd358e92f0b7c6428efc4b4c6b6c3f6 /Master | |
parent | 88df293243a8c9c3b5a1e72591a6e44075188c2e (diff) |
remove unnecessary =pod, other doc tweaks
git-svn-id: svn://tug.org/texlive/trunk@11705 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rw-r--r-- | Master/tlpkg/TeXLive/TLUtils.pm | 79 |
1 files changed, 23 insertions, 56 deletions
diff --git a/Master/tlpkg/TeXLive/TLUtils.pm b/Master/tlpkg/TeXLive/TLUtils.pm index c372dd0c766..1ba7e73b232 100644 --- a/Master/tlpkg/TeXLive/TLUtils.pm +++ b/Master/tlpkg/TeXLive/TLUtils.pm @@ -78,7 +78,6 @@ BEGIN { @EXPORT_OK = qw( &platform &platform_desc - &win32 &unix &getenv &which @@ -106,17 +105,15 @@ BEGIN { "ewords &conv_to_w32_path &untar - &setup_programs - &download_file &merge_into - &process_logging_options &welcome &welcome_paths &give_ctan_mirror &tlmd5 ); - @EXPORT = qw(setup_programs download_file info log debug ddebug dddebug - tlwarn process_logging_options win32 xchdir xsystem); + @EXPORT = qw(setup_programs download_file process_logging_options + tlwarn info log debug ddebug dddebug debug_hash + win32 xchdir xsystem); } use Cwd; @@ -127,8 +124,6 @@ use TeXLive::TLConfig; $::opt_verbosity = 0; # see process_logging_options -=pod - =head2 Platform Detection =over 4 @@ -269,7 +264,6 @@ sub platform { return $::_platform_; } -=pod =item C<platform_desc($platform)> @@ -316,7 +310,6 @@ sub platform_desc { } } -=pod =item C<win32> @@ -336,7 +329,6 @@ sub win32 # return (&platform eq "win32")? 1:0; } -=pod =item C<unix> @@ -348,7 +340,6 @@ sub unix { return (&platform eq "win32")? 0:1; } -=pod =back @@ -376,7 +367,6 @@ sub getenv { return "$var"; } -=pod =item C<which($string)> @@ -416,11 +406,11 @@ sub which { return 0; } -=pod =item C<get_system_tmpdir> Evaluate the environment variables C<TMPDIR>, C<TMP>, and C<TEMP> in order to find the system temporary directory. + =cut sub get_system_tmpdir { @@ -432,10 +422,11 @@ sub get_system_tmpdir { return "$systmp"; } -=pod + =item C<xchdir($dir)> C<chdir($dir)> or die. + =cut sub xchdir @@ -446,11 +437,9 @@ sub xchdir } -=pod =item C<xsystem(@args)> Run C<system(@args)> and die if unsuccessfully. -=cut sub xsystem { @@ -464,9 +453,9 @@ sub xsystem } } -=pod - + =back + =head2 File Utulities =over 4 @@ -528,7 +517,6 @@ sub dirname_and_basename { return ("$1", "$2"); } -=pod =item C<dir_writable($path)> @@ -575,7 +563,6 @@ sub dir_writable { } } -=pod =item C<mkdirhier($path, [$mode])> @@ -604,7 +591,6 @@ sub mkdirhier { } } -=pod =item C<rmtree($root, $verbose, $safe)> @@ -774,9 +760,9 @@ sub rmtree { $count; } -=pod =item C<copy($file, $target_dir)> + =item C<copy("-f", $file, $destfile)> Copy file C<$file> to directory C<$target_dir>, or to the C<$destfile> in @@ -856,7 +842,6 @@ sub copy { } -=pod =item C<touch(@files)> @@ -879,7 +864,6 @@ sub touch { } -=pod =item C<install_packages($from_tlpdb, $media, $to_tlpdb, $what, $opt_src, $opt_doc)> @@ -1054,9 +1038,8 @@ sub install_packages { $totmin, $totsec)); $totlpdb->save; } - -=pod + =item C<install_package($what, $size, $md5, $filelistref, $target, $platform)> This function installs the files given in @$filelistref from C<$what> @@ -1200,8 +1183,6 @@ sub install_package { } -=pod - =item C<untar($tarfile,$targetdir, $remove_tarfile)> Unpacked C<$tarfile> in C<$targetdir> (changing directories to @@ -1240,9 +1221,8 @@ sub untar { return $ret; } - -=pod + =item C<setup_programs( $bindir, $platform )> Populate the global C<$::progs> hash containing the paths to the @@ -1314,7 +1294,6 @@ sub setup_programs { return 1; } -=pod =item C<download_file( $relpath, $destination [, $progs ] )> @@ -1409,8 +1388,7 @@ sub _download_file { } } -=pod - + =back =head2 Installer Functions @@ -1437,7 +1415,6 @@ sub make_var_skeleton { mkdirhier "$prefix/tex/context/config"; } -=pod =item C<make_local_skeleton($prefix)> @@ -1462,8 +1439,7 @@ sub make_local_skeleton { } -=pod - + =item C<create_fmtutil($tlpdb, $dest, $localconf)> =item C<create_updmap($tlpdb, $dest, $localconf)> @@ -1544,8 +1520,8 @@ sub _create_config_files { } } -=pod + =back =head2 Miscellaneous @@ -1575,7 +1551,6 @@ sub sort_uniq { return @r; } -=pod =item C<push_uniq(\@list, @items)> @@ -1594,7 +1569,6 @@ sub push_uniq { } } -=pod =item C<member($item, @list)> @@ -1614,7 +1588,6 @@ sub member { return 0; } -=pod =item C<merge_into(\%to, \%from)> @@ -1633,7 +1606,6 @@ sub merge_into { } } -=pod =item C<texdir_check($texdir)> @@ -1682,7 +1654,6 @@ sub _logit { } } -=pod =item C<info ($str1, $str2, ...)> @@ -1706,7 +1677,6 @@ sub info { } } -=pod =item C<debug ($str1, $str2, ...)> @@ -1730,7 +1700,6 @@ sub debug { } } -=pod =item C<ddebug ($str1, $str2, ...)> @@ -1778,16 +1747,20 @@ sub dddebug { } +=item C<log ($str1, $str2, ...)> + +Write a message to the log file (and nowhere else), the concatenation of +the argument strings. + +=cut + sub log { - # warning should always done to stderr and the log file, - # independently from the verbosity level my $savequiet = $::opt_quiet; $::opt_quiet = 0; _logit('file', -100, @_); $::opt_quiet = $savequiet; } -=pod =item C<tlwarn ($str1, $str2, ...)> @@ -1811,11 +1784,11 @@ sub tlwarn { } -=pod =item C<debug_hash ($label, hash))> Write LABEL followed by HASH elements, all on one line, to stderr. If HASH is a reference, it is followed. + =cut sub debug_hash @@ -1838,8 +1811,6 @@ sub debug_hash } -=pod - =item C<process_logging_options ($texdir)> This function handles the common logging options for TeX Live scripts. @@ -1911,7 +1882,6 @@ sub process_logging_options { } } -=pod =item C<welcome> @@ -1935,7 +1905,6 @@ EOF return $welcome; } -=pod =item C<welcome> @@ -2003,7 +1972,6 @@ sub conv_to_w32_path { return($p); } -=pod =item C<give_ctan_mirror()> @@ -2115,10 +2083,9 @@ sub parse_line { } + 1; __END__ -=pod - =back =head1 SEE ALSO |