diff options
author | Norbert Preining <preining@logic.at> | 2007-06-16 16:30:21 +0000 |
---|---|---|
committer | Norbert Preining <preining@logic.at> | 2007-06-16 16:30:21 +0000 |
commit | 4e696440566b8dc5101c0a4d341b8445423e1f84 (patch) | |
tree | 1b99cd6a3e21956e66ee61337fedaf459360b607 /new-infra/Perl-API.txt | |
parent | d4eefe7213116b2b11dbfa09d39b54d6470203ca (diff) |
delete various old stuff
git-svn-id: svn://tug.org/texlive/trunk@4440 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'new-infra/Perl-API.txt')
-rw-r--r-- | new-infra/Perl-API.txt | 240 |
1 files changed, 0 insertions, 240 deletions
diff --git a/new-infra/Perl-API.txt b/new-infra/Perl-API.txt deleted file mode 100644 index 616c7eab40f..00000000000 --- a/new-infra/Perl-API.txt +++ /dev/null @@ -1,240 +0,0 @@ -API for Perl Modules for new infra -================================== - -Module TLSRC ------------- - -Constructor: - TLSRC->new; - TLSRC->new( name => "foobar", shortdesc => "The foobar package", ...); - -Input/Output - $tlsrc->from_file("package.tlsrc"); - $tlsrc->writeout - without arg to stdout - with arg to filehandle - -Read/Write functions (with argument set, without arg read) - - $tlsrc->name - $tlsrc->category - $tlsrc->shortdesc - $tlsrc->longdesc - $tlsrc->catalogue - $tlsrc->srcpatterns - $tlsrc->docpatterns - $tlsrc->runpatterns - $tlsrc->binpatterns - $tlsrc->depends - $tlsrc->executes - -Generation function - $tlp = $tlsrc->make_tlp($tltree); - generates a TLP object from itself (a TLSRC obj) and - a TLTREE object (see below) - - -Module TLP ----------- - -Package variables: - &TLP->zipdir - set/returns the default location for created zip files - -Constructur: - TLP->new; - TLP->new( name => "foobar", ...); - -Input/Output - $tlp->from_file("package.tlp"); - reads from file, only one tlp allowed in file - $tlp->from_fh($filehandle [, $multi] ); - reads from $filehandle - if $multi is undefined (ie not given) then multiple tlp - in the same file are treated as errors - if $multi is defined then returns after reading one - tlp - returns 1 if it found a tlp, otherwise 0 - $tlp->writeout - without arg to stdout - with arg to filehandle - $tlp->writeout_simple - for comparison with tpm/tlps, will go away - - $tlp->make_zip($tltree[,$destdir[,$zipname]]); - creates a zip file of the arch INDEPENDENT files in tlp - in $destdir (if not defined then TLP->zipdir is used). - The file name of the created zipfile is $zipname (if not - present $tlp->name.zip) - - If the package contains "binfiles"; then zip files for - all archs containing ONLY the binfiles are created, and - the zipfile name is - $zipname.$arch.zip - - (Compatibility with the scheme used before) - - $tlp->make_list($location) - create list files in $location (could be more than one for - packages with binary files) - WARNING: not completely implemented, I need someone who - explains me the list format, I cannot read the - foo2lists.xsl stuff arrggggg - -Utilities: - $tlp->recompute_sizes($tltree) - recomputes all the *size fields, see below - $tlp->recompute_revision($tltree) - recomputes the revision of the package - $tlp->is_arch_dependent - true if it contains bin files, otherwise false - $tlp->total_size - if no arguments given this is - srcsize + docsize + runsize - if args are given then this is - srcsize + docsize + runsize + - + sum_{i in args} binsize{$i} - -Read/Write functions (with argument set, without arg read) - - $tlp->name - $tlp->category - $tlp->revision - $tlp->shortdesc - $tlp->longdesc - $tlp->catalogue - reads/returns scalar - $tlp->srcfiles - $tlp->srcsize - $tlp->docfiles - $tlp->docsize - $tlp->runfiles - $tlp->runsize - *files reads/returns array of files - *size reads/returns scalar - $tlp->binfiles - $tlp->binsize - note that this gives/returns a HASH of architectures!! - $tlp->depends - $tlp->executes - reads/returns array - - $tlp->add_srcfiles(@files) - $tlp->remove_srcfiles(@files) - adds @files to the list of srcfiles - $tlp->add_docfiles(@files) - $tlp->remove_docfiles(@files) - adds @files to the list of docfiles - $tlp->add_runfiles(@files) - $tlp->remove_runfiles(@files) - adds/removes @files to the list of runfiles - - $tlp->add_binfiles($arch,@files) - $tlp->remove_binfiles($arch,@files) - adds/removes @files to the list of binfiles for arch=$arch - - $tlp->add_files($type,@files) - $tlp->remove_files($type,@files) - adds/removes @files to the list of $type = (run|doc|src)files - NOT FOR binfiles! - - -Module TLTREE -------------- -(this one is still quite hacky) - -Constructor - - TLTREE->new; - TLTREE->new( svnroot => "path/to/svn/managed/dir" ); - -Init functions - - $tltree->init_from_svn - changes to svnroot, calls svn status -v and builds - up all the necessary information - $tltree->init_from_statusfile($file) - does the same as init_from_svn, but from a pre-made - output of svn status -v - -Input/Ouput - - $tltree->print - to stdout, more or less for hacking only not usefull - -Pattern matching functions - - $ref = $tltree->get_matching_files($type,$pattern) - for $type = bin - returns a ref to a hash of keys = architectures - otherwise - returns a ref to an array - (see specification) - -Other functions - - $tltree->file_svn_lastrevision($file) - returns the revision of the last change of file - as given by svn status -v - undef if file is not contained in $tltree - - $tltree->size_of($file) - returns the size of $file, or undef if not in tree - - &$tlsrc->architectures - sets/reads the list of architectures, - predefined to .... - - -Module TLDB ------------ - -Constructore - - TLDB->new; - TLDB->new ( location => "path/to/tldb/file" ); - -Read/Write functions (with argument set, without arg read) - - $tldb->location - -Input/Output - - $tldb->from_file($filename); - reads a tldb file (tlp descriptions separated by newlines) - - $tldb->writeout - without arg to stdout - with arg to filehandle - - $tldb->save - saves to $self->location; - - $tldb->generate_packagelist - outputs list of "package revision" for web delivery - without arg to stdout - with arg to filehandle - -TLP interface - - $tldb->add_tlp($tlp) - adds a TLP to the TLDB (or replaces an already present) - - $tlp = $tldb->get_package("packagename"); - returns undef if not installed - - $rev = $tldb->package_revision("packagename"); - returns undef if not installed, otherwise the - revision of "packagename" - - -Package TLUtils ---------------- - -exported functions: - sort_uniq(@list) - push_uniq(\@list,@list) - dirname($file) - basename($file) - - |