summaryrefslogtreecommitdiff
path: root/Master/tlpkg/TeXLive
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-05-16 17:41:12 +0000
committerKarl Berry <karl@freefriends.org>2021-05-16 17:41:12 +0000
commitef42b50b6cb2e5aa8bc7cb5e75c3199b781cd105 (patch)
tree84529c1bc4834a9973566f02649eb4043d6333d9 /Master/tlpkg/TeXLive
parenteb5bab88c89769a2e1c477ba8271007cc41b832f (diff)
pod-isms
git-svn-id: svn://tug.org/texlive/trunk@59225 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/TeXLive')
-rw-r--r--Master/tlpkg/TeXLive/TLConfig.pm6
-rw-r--r--Master/tlpkg/TeXLive/TLPDB.pm2
-rw-r--r--Master/tlpkg/TeXLive/TLTREE.pm31
-rw-r--r--Master/tlpkg/TeXLive/TLWinGoo.pm10
-rw-r--r--Master/tlpkg/TeXLive/TeXCatalogue.pm6
5 files changed, 32 insertions, 23 deletions
diff --git a/Master/tlpkg/TeXLive/TLConfig.pm b/Master/tlpkg/TeXLive/TLConfig.pm
index f1bfd18d3bc..423f10d8ff2 100644
--- a/Master/tlpkg/TeXLive/TLConfig.pm
+++ b/Master/tlpkg/TeXLive/TLConfig.pm
@@ -288,13 +288,13 @@ C<TeXLive::TLConfig> -- TeX Live configuration parameters
The L<TeXLive::TLConfig> module contains definitions of variables
configuring all of TeX Live.
-=over 4
-
-=head1 EXPORTED VARIABLES
+=head2 EXPORTED VARIABLES
All of the following variables are pulled into the callers namespace,
i.e., are declared with C<EXPORT> (and C<EXPORT_OK>).
+=over 4
+
=item C<@TeXLive::TLConfig::MetaCategories>
The list of meta categories, i.e., those categories whose packages only
diff --git a/Master/tlpkg/TeXLive/TLPDB.pm b/Master/tlpkg/TeXLive/TLPDB.pm
index ac2c5239cff..1f258c4451e 100644
--- a/Master/tlpkg/TeXLive/TLPDB.pm
+++ b/Master/tlpkg/TeXLive/TLPDB.pm
@@ -14,7 +14,7 @@ sub module_revision { return $_modulerevision; }
=head1 NAME
-C<TeXLive::TLPDB> -- TeX Live Package Database module
+C<TeXLive::TLPDB> -- TeX Live Package Database (C<texlive.tlpdb>) module
=head1 SYNOPSIS
diff --git a/Master/tlpkg/TeXLive/TLTREE.pm b/Master/tlpkg/TeXLive/TLTREE.pm
index f1abcd7fe03..92b4914faa5 100644
--- a/Master/tlpkg/TeXLive/TLTREE.pm
+++ b/Master/tlpkg/TeXLive/TLTREE.pm
@@ -10,6 +10,24 @@ my $svnrev = '$Revision$';
my $_modulerevision = ($svnrev =~ m/: ([0-9]+) /) ? $1 : "unknown";
sub module_revision { return $_modulerevision; }
+=pod
+
+=head1 NAME
+
+C<TeXLive::TLTREE> -- TeX Live tree of all files
+
+=head1 SYNOPSIS
+
+ use TeXLive::TLTREE;
+ TeXLive::TLTREE->new ();
+ ...
+
+=head1 DESCRIPTION
+
+DOCUMENTATION MISSING, SORRY!!!
+
+=cut
+
use TeXLive::TLUtils;
sub new {
@@ -534,19 +552,6 @@ sub architectures {
1;
-=head1 NAME
-
-C<TeXLive::TREE> -- TeX Live tree of all files
-
-=head1 SYNOPSIS
-
- use TeXLive::TREE;
- TeXLive::TREE->new ();
-
-=head1 DESCRIPTION
-
-Sorry, haven't written documentation for this one yet.
-
=head1 SEE ALSO
The modules L<TeXLive::TLPSRC>, L<TeXLive::TLPOBJ>, L<TeXLive::TLPDB>,
diff --git a/Master/tlpkg/TeXLive/TLWinGoo.pm b/Master/tlpkg/TeXLive/TLWinGoo.pm
index 27a3acdeb0d..941ee315159 100644
--- a/Master/tlpkg/TeXLive/TLWinGoo.pm
+++ b/Master/tlpkg/TeXLive/TLWinGoo.pm
@@ -78,7 +78,7 @@ C<TeXLive::TLWinGoo> -- TeX Live Windows-specific support
All exported functions return forward slashes.
-=head2 DESCRIPTION
+=head1 DESCRIPTION
=over 4
@@ -1318,6 +1318,12 @@ sub unregister_uninstaller {
=pod
+=back
+
+=head2 ADMIN
+
+=over 4
+
=item C<TeXLive::TLWinGoo::maybe_make_ro($dir)>
Write-protects a directory $dir recursively, using ACLs, but only if
@@ -1325,6 +1331,8 @@ we are a multi-user install, and only if $dir is on an
NTFS-formatted local fixed disk, and only on Windows Vista and
later. It writes a log message what it does and why.
+=back
+
=cut
sub maybe_make_ro {
diff --git a/Master/tlpkg/TeXLive/TeXCatalogue.pm b/Master/tlpkg/TeXLive/TeXCatalogue.pm
index c2924fc9826..014ab02da03 100644
--- a/Master/tlpkg/TeXLive/TeXCatalogue.pm
+++ b/Master/tlpkg/TeXLive/TeXCatalogue.pm
@@ -21,11 +21,7 @@ sub module_revision { return $_modulerevision; }
=head1 NAME
-TeXLive::TeXCatalogue - TeX Live access to the TeX Catalogue fromCTAN
-
-=head1 SYNOPSIS
-
-missing
+C<TeXLive::TeXCatalogue> - TeX Live access to the TeX Catalogue from CTAN
=head1 DESCRIPTION