Tamar 0.7.2 → 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,187 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html>
4
+ <head>
5
+ <title>Reference</title>
6
+ <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7
+ <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8
+ </head>
9
+
10
+ <body>
11
+ <div id="container">
12
+
13
+ <div id="product">
14
+ <div id="product_logo"></div>
15
+ <div id="product_name"><big><b></b></big></div>
16
+ <div id="product_description"></div>
17
+ </div> <!-- id="product" -->
18
+
19
+ <div id="main">
20
+
21
+ <div id="navigation">
22
+
23
+
24
+ <h1>LuaDoc</h1>
25
+ <ul>
26
+
27
+ <li><a href="../index.html">Index</a></li>
28
+
29
+ </ul>
30
+
31
+
32
+ <!-- Module list -->
33
+
34
+ <h1>Modules</h1>
35
+ <ul>
36
+
37
+ <li>
38
+ <a href="../modules/dist.html">dist</a>
39
+ </li>
40
+
41
+ <li>
42
+ <a href="../modules/dist.dep.html">dist.dep</a>
43
+ </li>
44
+
45
+ <li>
46
+ <a href="../modules/dist.fetch.html">dist.fetch</a>
47
+ </li>
48
+
49
+ <li><strong>dist.log</strong></li>
50
+
51
+ <li>
52
+ <a href="../modules/dist.manifest.html">dist.manifest</a>
53
+ </li>
54
+
55
+ <li>
56
+ <a href="../modules/dist.package.html">dist.package</a>
57
+ </li>
58
+
59
+ <li>
60
+ <a href="../modules/dist.persist.html">dist.persist</a>
61
+ </li>
62
+
63
+ <li>
64
+ <a href="../modules/dist.sys.html">dist.sys</a>
65
+ </li>
66
+
67
+ </ul>
68
+
69
+
70
+
71
+ <!-- File list -->
72
+
73
+
74
+
75
+
76
+
77
+
78
+ </div><!-- id="navigation" -->
79
+
80
+ <div id="content">
81
+
82
+ <h1>Module <code>dist.log</code></h1>
83
+
84
+ <p>Very simple log system. 2DO: change to LuaLogging on next version. write - write a log line message - write and optionally display a message</p>
85
+
86
+
87
+
88
+
89
+
90
+ <h2>Functions</h2>
91
+ <table class="function_list">
92
+
93
+ <tr>
94
+ <td class="name" nowrap><a href="#message">message</a>&nbsp;(...)</td>
95
+ <td class="summary">Display and log a message </td>
96
+ </tr>
97
+
98
+ <tr>
99
+ <td class="name" nowrap><a href="#write">write</a>&nbsp;(...)</td>
100
+ <td class="summary">Write a line to log </td>
101
+ </tr>
102
+
103
+ </table>
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <br/>
111
+ <br/>
112
+
113
+
114
+
115
+ <h2><a name="functions"></a>Functions</h2>
116
+ <dl class="function">
117
+
118
+
119
+
120
+ <dt><a name="message"></a><strong>message</strong>&nbsp;(...)</dt>
121
+ <dd>
122
+ Display and log a message
123
+
124
+
125
+ <h3>Parameters</h3>
126
+ <ul>
127
+
128
+ <li>
129
+ ...:
130
+ </li>
131
+
132
+ </ul>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ </dd>
142
+
143
+
144
+
145
+
146
+ <dt><a name="write"></a><strong>write</strong>&nbsp;(...)</dt>
147
+ <dd>
148
+ Write a line to log
149
+
150
+
151
+ <h3>Parameters</h3>
152
+ <ul>
153
+
154
+ <li>
155
+ ...:
156
+ </li>
157
+
158
+ </ul>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ </dd>
168
+
169
+
170
+ </dl>
171
+
172
+
173
+
174
+
175
+
176
+
177
+ </div> <!-- id="content" -->
178
+
179
+ </div> <!-- id="main" -->
180
+
181
+ <div id="about">
182
+ <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
183
+ </div> <!-- id="about" -->
184
+
185
+ </div> <!-- id="container" -->
186
+ </body>
187
+ </html>
@@ -0,0 +1,235 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html>
4
+ <head>
5
+ <title>Reference</title>
6
+ <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7
+ <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8
+ </head>
9
+
10
+ <body>
11
+ <div id="container">
12
+
13
+ <div id="product">
14
+ <div id="product_logo"></div>
15
+ <div id="product_name"><big><b></b></big></div>
16
+ <div id="product_description"></div>
17
+ </div> <!-- id="product" -->
18
+
19
+ <div id="main">
20
+
21
+ <div id="navigation">
22
+
23
+
24
+ <h1>LuaDoc</h1>
25
+ <ul>
26
+
27
+ <li><a href="../index.html">Index</a></li>
28
+
29
+ </ul>
30
+
31
+
32
+ <!-- Module list -->
33
+
34
+ <h1>Modules</h1>
35
+ <ul>
36
+
37
+ <li>
38
+ <a href="../modules/dist.html">dist</a>
39
+ </li>
40
+
41
+ <li>
42
+ <a href="../modules/dist.dep.html">dist.dep</a>
43
+ </li>
44
+
45
+ <li>
46
+ <a href="../modules/dist.fetch.html">dist.fetch</a>
47
+ </li>
48
+
49
+ <li>
50
+ <a href="../modules/dist.log.html">dist.log</a>
51
+ </li>
52
+
53
+ <li><strong>dist.manifest</strong></li>
54
+
55
+ <li>
56
+ <a href="../modules/dist.package.html">dist.package</a>
57
+ </li>
58
+
59
+ <li>
60
+ <a href="../modules/dist.persist.html">dist.persist</a>
61
+ </li>
62
+
63
+ <li>
64
+ <a href="../modules/dist.sys.html">dist.sys</a>
65
+ </li>
66
+
67
+ </ul>
68
+
69
+
70
+
71
+ <!-- File list -->
72
+
73
+
74
+
75
+
76
+
77
+
78
+ </div><!-- id="navigation" -->
79
+
80
+ <div id="content">
81
+
82
+ <h1>Module <code>dist.manifest</code></h1>
83
+
84
+ <p>The purpose of this module is to check and collect dist manifests. There are three functions provided: make - Generates manifest for local directory get - Gets sorted manifest from URI, this uses make for local paths. For remote directories it requires dist.manifest file to be present. info - Loads and/or corrects and checks dist.info contents Dists and manifests are simply arrays of collected dist.info files.</p>
85
+
86
+
87
+
88
+
89
+
90
+ <h2>Functions</h2>
91
+ <table class="function_list">
92
+
93
+ <tr>
94
+ <td class="name" nowrap><a href="#get">get</a>&nbsp;(src, variables, url)</td>
95
+ <td class="summary">Get or generate repository contents from URI.</td>
96
+ </tr>
97
+
98
+ <tr>
99
+ <td class="name" nowrap><a href="#info">info</a>&nbsp;(dist)</td>
100
+ <td class="summary">Load and check info from file or check info table </td>
101
+ </tr>
102
+
103
+ <tr>
104
+ <td class="name" nowrap><a href="#make">make</a>&nbsp;(dir)</td>
105
+ <td class="summary">Collect and sort dists in a directory.</td>
106
+ </tr>
107
+
108
+ </table>
109
+
110
+
111
+
112
+
113
+
114
+
115
+ <br/>
116
+ <br/>
117
+
118
+
119
+
120
+ <h2><a name="functions"></a>Functions</h2>
121
+ <dl class="function">
122
+
123
+
124
+
125
+ <dt><a name="get"></a><strong>get</strong>&nbsp;(src, variables, url)</dt>
126
+ <dd>
127
+ Get or generate repository contents from URI.
128
+
129
+
130
+ <h3>Parameters</h3>
131
+ <ul>
132
+
133
+ <li>
134
+ src:
135
+ </li>
136
+
137
+ <li>
138
+ variables:
139
+ </li>
140
+
141
+ <li>
142
+ url: string: URL to load the dist.manifest from. In case file:// is used generate the manifest.
143
+ </li>
144
+
145
+ </ul>
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <h3>Return value:</h3>
153
+ dists, log: Returns true on success and nil and error message on failure.
154
+
155
+
156
+
157
+ </dd>
158
+
159
+
160
+
161
+
162
+ <dt><a name="info"></a><strong>info</strong>&nbsp;(dist)</dt>
163
+ <dd>
164
+ Load and check info from file or check info table
165
+
166
+
167
+ <h3>Parameters</h3>
168
+ <ul>
169
+
170
+ <li>
171
+ dist: string or table: Path to dist.info or info table to check.
172
+ </li>
173
+
174
+ </ul>
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <h3>Return value:</h3>
182
+ info, log: Table containing loaded and checked info or nil and log message.
183
+
184
+
185
+
186
+ </dd>
187
+
188
+
189
+
190
+
191
+ <dt><a name="make"></a><strong>make</strong>&nbsp;(dir)</dt>
192
+ <dd>
193
+ Collect and sort dists in a directory.
194
+
195
+
196
+ <h3>Parameters</h3>
197
+ <ul>
198
+
199
+ <li>
200
+ dir: string: Directory to get manifest from.
201
+ </li>
202
+
203
+ </ul>
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <h3>Return value:</h3>
211
+ dists, log: Dists in the directory and log message.
212
+
213
+
214
+
215
+ </dd>
216
+
217
+
218
+ </dl>
219
+
220
+
221
+
222
+
223
+
224
+
225
+ </div> <!-- id="content" -->
226
+
227
+ </div> <!-- id="main" -->
228
+
229
+ <div id="about">
230
+ <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
231
+ </div> <!-- id="about" -->
232
+
233
+ </div> <!-- id="container" -->
234
+ </body>
235
+ </html>
@@ -0,0 +1,323 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html>
4
+ <head>
5
+ <title>Reference</title>
6
+ <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7
+ <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8
+ </head>
9
+
10
+ <body>
11
+ <div id="container">
12
+
13
+ <div id="product">
14
+ <div id="product_logo"></div>
15
+ <div id="product_name"><big><b></b></big></div>
16
+ <div id="product_description"></div>
17
+ </div> <!-- id="product" -->
18
+
19
+ <div id="main">
20
+
21
+ <div id="navigation">
22
+
23
+
24
+ <h1>LuaDoc</h1>
25
+ <ul>
26
+
27
+ <li><a href="../index.html">Index</a></li>
28
+
29
+ </ul>
30
+
31
+
32
+ <!-- Module list -->
33
+
34
+ <h1>Modules</h1>
35
+ <ul>
36
+
37
+ <li>
38
+ <a href="../modules/dist.html">dist</a>
39
+ </li>
40
+
41
+ <li>
42
+ <a href="../modules/dist.dep.html">dist.dep</a>
43
+ </li>
44
+
45
+ <li>
46
+ <a href="../modules/dist.fetch.html">dist.fetch</a>
47
+ </li>
48
+
49
+ <li>
50
+ <a href="../modules/dist.log.html">dist.log</a>
51
+ </li>
52
+
53
+ <li>
54
+ <a href="../modules/dist.manifest.html">dist.manifest</a>
55
+ </li>
56
+
57
+ <li><strong>dist.package</strong></li>
58
+
59
+ <li>
60
+ <a href="../modules/dist.persist.html">dist.persist</a>
61
+ </li>
62
+
63
+ <li>
64
+ <a href="../modules/dist.sys.html">dist.sys</a>
65
+ </li>
66
+
67
+ </ul>
68
+
69
+
70
+
71
+ <!-- File list -->
72
+
73
+
74
+
75
+
76
+
77
+
78
+ </div><!-- id="navigation" -->
79
+
80
+ <div id="content">
81
+
82
+ <h1>Module <code>dist.package</code></h1>
83
+
84
+ <p>Package handling functions. This module deals with packages, these are unpacked dists in LuaDist terminology The following functions are provided: unpack - fetch and unpack a dist build - compile a source dist deploy - install a dist into deployment dir and/or fix links. pack - create dist from package delete - delete package</p>
85
+
86
+
87
+
88
+
89
+
90
+ <h2>Functions</h2>
91
+ <table class="function_list">
92
+
93
+ <tr>
94
+ <td class="name" nowrap><a href="#build">build</a>&nbsp;(dist, depl, variables)</td>
95
+ <td class="summary">Build, deploy and test a source dist using CMake.</td>
96
+ </tr>
97
+
98
+ <tr>
99
+ <td class="name" nowrap><a href="#delete">delete</a>&nbsp;(dist, depl)</td>
100
+ <td class="summary">Delete a deployed dist.</td>
101
+ </tr>
102
+
103
+ <tr>
104
+ <td class="name" nowrap><a href="#deploy">deploy</a>&nbsp;(dist, depl)</td>
105
+ <td class="summary">Deploy dist into deployment directory.</td>
106
+ </tr>
107
+
108
+ <tr>
109
+ <td class="name" nowrap><a href="#pack">pack</a>&nbsp;(dist, depl, dir)</td>
110
+ <td class="summary">Pack a package to create a dist.</td>
111
+ </tr>
112
+
113
+ <tr>
114
+ <td class="name" nowrap><a href="#unpack">unpack</a>&nbsp;(url, dest)</td>
115
+ <td class="summary">Fetch and unpack zip/dist from URL into dest directory.</td>
116
+ </tr>
117
+
118
+ </table>
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <br/>
126
+ <br/>
127
+
128
+
129
+
130
+ <h2><a name="functions"></a>Functions</h2>
131
+ <dl class="function">
132
+
133
+
134
+
135
+ <dt><a name="build"></a><strong>build</strong>&nbsp;(dist, depl, variables)</dt>
136
+ <dd>
137
+ Build, deploy and test a source dist using CMake.
138
+
139
+
140
+ <h3>Parameters</h3>
141
+ <ul>
142
+
143
+ <li>
144
+ dist: string: Directory of the source dist to build.
145
+ </li>
146
+
147
+ <li>
148
+ depl:
149
+ </li>
150
+
151
+ <li>
152
+ variables:
153
+ </li>
154
+
155
+ </ul>
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <h3>Return value:</h3>
163
+ path, log: Returns temporary directory the dist was build into and log message.
164
+
165
+
166
+
167
+ </dd>
168
+
169
+
170
+
171
+
172
+ <dt><a name="delete"></a><strong>delete</strong>&nbsp;(dist, depl)</dt>
173
+ <dd>
174
+ Delete a deployed dist.
175
+
176
+
177
+ <h3>Parameters</h3>
178
+ <ul>
179
+
180
+ <li>
181
+ dist: string: dist to delete.
182
+ </li>
183
+
184
+ <li>
185
+ depl: string: deployment dir to delete from.
186
+ </li>
187
+
188
+ </ul>
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <h3>Return value:</h3>
196
+ ok, log: Returns success and nlog message.
197
+
198
+
199
+
200
+ </dd>
201
+
202
+
203
+
204
+
205
+ <dt><a name="deploy"></a><strong>deploy</strong>&nbsp;(dist, depl)</dt>
206
+ <dd>
207
+ Deploy dist into deployment directory.
208
+
209
+
210
+ <h3>Parameters</h3>
211
+ <ul>
212
+
213
+ <li>
214
+ dist: string: Directory of the dist to deploy.
215
+ </li>
216
+
217
+ <li>
218
+ depl: string: Deployment directory nil for default.
219
+ </li>
220
+
221
+ </ul>
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <h3>Return value:</h3>
229
+ ok, log: Returns true on success and log message.
230
+
231
+
232
+
233
+ </dd>
234
+
235
+
236
+
237
+
238
+ <dt><a name="pack"></a><strong>pack</strong>&nbsp;(dist, depl, dir)</dt>
239
+ <dd>
240
+ Pack a package to create a dist.
241
+
242
+
243
+ <h3>Parameters</h3>
244
+ <ul>
245
+
246
+ <li>
247
+ dist: string: deployed dist to pack.
248
+ </li>
249
+
250
+ <li>
251
+ depl: string: deployment dir to pack from.
252
+ </li>
253
+
254
+ <li>
255
+ dir: string: Optional destination for the dist, current directory will be used by default.
256
+ </li>
257
+
258
+ </ul>
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <h3>Return value:</h3>
266
+ ok, log: Returns success and log message.
267
+
268
+
269
+
270
+ </dd>
271
+
272
+
273
+
274
+
275
+ <dt><a name="unpack"></a><strong>unpack</strong>&nbsp;(url, dest)</dt>
276
+ <dd>
277
+ Fetch and unpack zip/dist from URL into dest directory.
278
+
279
+
280
+ <h3>Parameters</h3>
281
+ <ul>
282
+
283
+ <li>
284
+ url: string: Local packed dist or URL to fetch dist from.
285
+ </li>
286
+
287
+ <li>
288
+ dest: string: Destination to unpack contents into, nil for temp directory.
289
+ </li>
290
+
291
+ </ul>
292
+
293
+
294
+
295
+
296
+
297
+
298
+ <h3>Return value:</h3>
299
+ path, log: Unpacked dist path or nil and log.
300
+
301
+
302
+
303
+ </dd>
304
+
305
+
306
+ </dl>
307
+
308
+
309
+
310
+
311
+
312
+
313
+ </div> <!-- id="content" -->
314
+
315
+ </div> <!-- id="main" -->
316
+
317
+ <div id="about">
318
+ <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
319
+ </div> <!-- id="about" -->
320
+
321
+ </div> <!-- id="container" -->
322
+ </body>
323
+ </html>