summaryrefslogtreecommitdiff
path: root/new-infra/specification.txt
diff options
context:
space:
mode:
Diffstat (limited to 'new-infra/specification.txt')
-rw-r--r--new-infra/specification.txt84
1 files changed, 84 insertions, 0 deletions
diff --git a/new-infra/specification.txt b/new-infra/specification.txt
new file mode 100644
index 00000000000..4364ad00cb1
--- /dev/null
+++ b/new-infra/specification.txt
@@ -0,0 +1,84 @@
+Specifications
+==============
+
+(I opt AGAINST @foobar, this makes perl code much more complicate!)
+
+1) tlsrc
+--------
+one file *WITHOUT* empty lines (but beginning and end)
+every line looks like
+ key value
+possible keys are
+ name (must be first)
+ shortdesc
+ longdesc
+ catalogue
+ runpattern
+ srcpattern
+ docpattern
+ binpattern
+ execute
+ depend
+
+Interpretation:
+name
+ name of the package
+
+catalogue
+ name of the respective Catalogue entry, if missing, same as name
+
+(run|src|doc|bin)pattern
+ list of pattern of the form
+ TYPE PAT
+ where
+ TYPE = d f
+ and PAT is a free text
+ if there is a line
+ pattern d texmf-dist/.*/foobar
+ then all files in leaf directories named foobar under texmf-dist
+ are included
+ a line
+ pattern f bin/${ARCH}/.*${EXT}
+ includes all files which are in bin/$ARCH/ and have extension ${EXT}
+ where ARCH and EXT are expanded by the tlsrc interpreter
+
+execute free from
+ is taken one to one into the tlp file
+
+depend
+ is taken one to one into the tlp file
+
+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
+ revision
+ shortdesc
+ longdesc
+ catalogue
+ binfiles
+ runfiles
+ docfiles
+ srcfiles
+ execute
+ depend
+ ??? what am I missing ???
+
+Interpretation
+ obvious
+
+3) tldp file
+------------
+concatenation of all the tlp files, separated by empty line(s)
+
+