summaryrefslogtreecommitdiff
path: root/new-infra/specification.txt
blob: d6fb56ed281afd5f19420ba3b324d330dff80be6 (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
	runpatterns
	srcpatterns
	docpatterns
	binpatterns
	execute
	depend

Interpretation:
name
	name of the 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:
		TYPE PAT
		TYPE = d f t
	t word1 ... wordN wordL
		include all files below all dirs of the form
			word1/.../wordN/.../wordL/...
		(cheap)
	d regexp
		include all files in directory mathing regexp
		(expensive)
	f regexp
		include all files matching regexp
		(expensive)
	
	new idea???
	list of pattern of the form
		TYPE PAT
	where
		TYPE = d f t r
	and PAT is a free text

	t word1 ... wordN wordL
		include all files below all dirs of the form
			word1/.../wordN/.../wordL/...
		(cheap)
	
	d string
		include all files below the directory d (now expansion at all)
		(should we add glob expansion?)
		(cheap, with glob I don't know)

	f string
		include file string
		(should we add glob expansion?)
		(cheap, with glob I don't know)
	
	r regexp
		includes all files which are matched by regexp
		(expensive)

	Note that if one of the patterns section is empty an entry 
	is automatically generated:
	for runpatterns:
		t texmf-dist topdir $tlp
			(with topdir = bibtex, context, ... see tlsrc2tlp.pl)
	for docpatterns:
		t texmf-dist doc $tlp
	for srcpatterns:
		t texmf-dist source $tlp
	for binpatterns:
		NONE!!	

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
	revision
	shortdesc
	longdesc
	catalogue
	binfiles
	runfiles
	docfiles
	srcfiles
	execute
	depend
	??? what am I missing ???

Interpretation
	obvious

	revision
		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)