File: pstructure.inc

package info (click to toggle)
critcl 3.3.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,680 kB
  • sloc: ansic: 41,058; tcl: 12,090; sh: 7,230; pascal: 3,456; asm: 3,058; ada: 1,681; cpp: 1,001; cs: 879; makefile: 333; perl: 104; xml: 95; f90: 10
file content (64 lines) | stat: -rw-r--r-- 1,753 bytes parent folder | download | duplicates (4)
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

Packages generated by critcl have the following basic structure:

[example {
<TOP>
+- pkgIndex.tcl
+- critcl-rt.tcl
+- license.terms (optional)
|
+- tcl (optional)
|  +- <tsources files>
|
+- <platform>
   +- <shared library>
}]

[para][emph Notes]
[list_begin enumerated]

[enum] The file [file pkgIndex.tcl] is the standard package index file
expected by Tcl's package management. It is sourced during a search
for packages, and declares the package to Tcl with its files, and how
to handle them.

[enum] The file [file critcl-rt.tcl] is a helper file containing the
common code used by [file pkgIndex.tcl] to perform its tasks.

[enum] The file [file license.terms] is optional and appears only if
the [file .critcl] file the package is generated from used the command
[cmd critcl::license] to declare package author and license.

[enum] All files declared with the command [cmd critcl::tsources] are
put into the sub-directory [file tcl].

[enum] The shared library generated by critcl is put into a
platform-specific sub-directory.

[list_end]

[para] The whole structure, and especially the last point, enable us
to later merge the results (for the same package, and version) for
multiple target platforms into a single directory structure without
conflict, by simply copying the top directories over each other. The
only files which can conflict are in the <TOP> and [file tcl]
directories, and for these we know that they are identical across
targets. The result of such a merge would look like:

[example {
<TOP>
+- pkgIndex.tcl
+- critcl-rt.tcl
+- license.terms (optional)
|
+- tcl (optional)
|  +- <tsources files>
|
+- <platform1>
|  +- <shared library1>
+- <platform2>
|  +- <shared library2>
...
+- <platformN>
   +- <shared libraryN>
}]