summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc/specification.txt
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2007-06-16 16:22:16 +0000
committerNorbert Preining <preining@logic.at>2007-06-16 16:22:16 +0000
commitd4eefe7213116b2b11dbfa09d39b54d6470203ca (patch)
treed0fa75c399323763c095e1ac6d77ae6766ab88e5 /Master/tlpkg/doc/specification.txt
parentad7c8ab6419951c6e744c47c4be81bef897a18b3 (diff)
move new-infra to Master/tlpkg
rename stuff create list files tlsrc for all packages (also schemes) git-svn-id: svn://tug.org/texlive/trunk@4439 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc/specification.txt')
-rw-r--r--Master/tlpkg/doc/specification.txt141
1 files changed, 141 insertions, 0 deletions
diff --git a/Master/tlpkg/doc/specification.txt b/Master/tlpkg/doc/specification.txt
new file mode 100644
index 00000000000..4c24ce56b8e
--- /dev/null
+++ b/Master/tlpkg/doc/specification.txt
@@ -0,0 +1,141 @@
+Specifications
+==============
+
+1) tlsrc
+--------
+one file *WITHOUT* empty lines (but beginning and end)
+every line looks like
+ key value
+possible keys are
+ name (must be first)
+ category
+ shortdesc
+ longdesc
+ catalogue
+ runpatterns
+ srcpatterns
+ docpatterns
+ binpatterns
+ execute
+ depend
+
+Interpretation:
+name
+ name of the package
+
+category
+ TLCore Package Documentation
+ as well known from tpms
+ if none specified it is Package
+
+catalogue
+ name of the respective Catalogue entry, if missing, same as name
+
+(run|src|doc|bin)patterns
+ (cheap/expensive means working time)
+
+ current status:
+ [PREFIX]TYPE PAT
+ TYPE = t f d r
+ PREFIX = + | +! | !
+ t word1 ... wordN wordL
+ include all files below all dirs of the form
+ word1/.../wordN/.../wordL/...
+ (cheap)
+ f string
+ include file "string" where the LAST(!!!) entry (basename)
+ of string can contain glob characters * and ? (but no other!)
+ (cheap)
+ d string
+ include all files in and below the directory "string"
+ (cheap)
+ r regexp
+ include all files matching /^regexp$/
+ (expensive)
+
+ Note that if one of the patterns section is empty OR (!!!) all
+ provided patterns have the prefix "+" (eg "+f ...."), then
+ the following patterns are added:
+ for runpatterns:
+ t texmf-dist topdir $tlp for type = Package
+ (with topdir = bibtex, context, ... see tlsrc2tlp.pl)
+ for docpatterns:
+ t texmf-dist doc $tlp for type = Package
+ t texmf-doc doc $tlp for type = Documentation
+ for srcpatterns:
+ t texmf-dist source $tlp for type = Package
+ t texmf-doc source $tlp for type = Documentation
+ for binpatterns:
+ NONE!!
+
+ If the prefix contains a ! the pattern is negated, ie after all the
+ files for positive patterns have been added, those matching the
+ negative patterns are removed.
+
+execute free form
+ is taken one to one into the tlp file
+
+depend
+ is taken one to one into the tlp file
+ made up of
+ Type/Package
+ where
+ Type ::= TLCore | Documentation | Package
+
+shortdesc
+ short one line desc
+ is taken one to one into the tlp file
+ if missing can be taken from Catalogue
+
+longdesc
+ longer multiline dscription
+ is taken one to one into the tlp file
+ if missing can be taken from Catalogue
+
+2) tlp file
+-----------
+same format as tlsrc, but the keys are
+ name
+ category
+ revision
+ shortdesc
+ longdesc
+ catalogue
+ runfiles
+ docfiles
+ srcfiles
+ binfiles
+ execute
+ depend
+ ??? what am I missing ???
+
+Interpretation
+ bin|src|doc|runfiles MUST be saved in multi line entries with
+ continuation lines intended by one (1) space. all of them
+ can have (must have?) the size tag size=......, in addition
+ binfiles can have the arch tag arch=...
+ /----------
+ |docfiles size=....
+ | file1
+ | file2
+ | ...
+ For binfiles the architecture can be given on the binfile line:
+ /------------
+ |binfiles arch=i386-solaris size=....
+ | file1
+ | file2
+ | file3
+ | ...
+ Note that only *ONE* *files entry per tlp is allowed
+
+ rest obvious
+
+ revision
+ maxmimum of all the last_changed_revisions of all
+ contained files
+
+3) tldb file
+------------
+concatenation of all the tlp files, separated by empty line(s)
+
+