summaryrefslogtreecommitdiff
path: root/new-infra/specification.txt
blob: e1e393ada26a83428559043f067cf800d75ccbaf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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 form
	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
	packageversion
	revision
	shortdesc
	longdesc
	catalogue
	binfiles
	runfiles
	docfiles
	srcfiles
	execute
	depend
	??? what am I missing ???

Interpretation
	obvious

	packageversion
		maxmimum of all the last_changed_revisions of all
		contained files

3) tldp file
------------
concatenation of all the tlp files, separated by empty line(s)