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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
<html>
<head>
<title>Getting Started with arch</title>
</head>
<body>
<a name="Getting_Started_with_arch"></a>
<a href="http://www.regexps.com">The Hackerlab at <code>regexps.com</code></a>
<h2 align=center>Getting Started with arch</h2>
<small>
<b>up: </b><a href="arch.html#arch">arch</a></br>
<b>next: </b><a href="implementing-policies.html#Implementing_Development_Policies">Implementing Development Policies</a></br>
</small>
<br>
<p>Here is a whirlwind guide to getting started with <code>arch</code>
. This appendix
presumes that you are familiar with the material in previous chapters.
</p><p>After building and installing <code>arch</code>
, try these steps:
</p>
<a name="Set_Your_arch_User_Id"></a>
<h3 align=center>Set Your arch User Id</h3>
<p>The first step is to set your id with a command like:
</p><pre>
% larch my-id "Jane Hacker <jane.hacker@gnu.org>"
</pre>
<p>See <a href="user-names.html#The_arch_Global_Name-space_of_Users">The arch Global Name-space of Users</a>.
</p>
<a name="Create_Your_First_Archive"></a>
<h3 align=center>Create Your First Archive</h3>
<p>Create your own archive with:
</p><pre>
% larch make-archive NAME DIRECTORY
</pre>
<p>Make that your default archive with:
</p><pre>
% larch my-default-archive NAME
</pre>
<p>You might want to edit the top-level <code>=README</code>
file in your archive to
describe what you intend to store there. Editting <code>=README</code>
files is
one of the few exceptions to the rule that you should never modify
files in the archive "by hand".
</p><p>See <a href="archives.html#Archives">Archives</a>.
</p>
<a name="Create_Your_Revision_Library"></a>
<h3 align=center>Create Your Revision Library</h3>
<p>Revision libraries are strictly optional, but they are desirable
if you want to obtain the best performance from <code>arch</code>
or use all
of the available features.
</p><p>To create a library, simply create an empty directory:
</p><pre>
% mkdir "{revisions}"
</pre>
<p>and tell <code>arch</code>
about it:
</p><pre>
% larch my-revision-library "`pwd`/{revisions}"
</pre>
<p>See <a href="revision-lib.html#Revision_Tree_Libraries">Revision Tree Libraries</a>.
</p>
<a name="Set_Up_Your_Revision_Browser"></a>
<h3 align=center>Set Up Your Revision Browser</h3>
<p>If you want to be able to browse change sets and past revisions with a
web browser, you need to set up a browser directory.
</p><p>Create an empty directory:
</p><pre>
% mkdir "{browser}"
</pre>
<p>and mark that directory as a browser:
</p><pre>
% touch "{browser}/=browser"
</pre>
<p>There is no need to inform <code>arch</code>
of the location of your browser at
this step -- that will come later when you set up a "notifier" which
updates the browser.
</p><p>See <a href="web-site.html#arch_Web_Site_Generation_Tools">arch Web Site Generation Tools</a>.
</p>
<a name="Set_Up_Notifiers"></a>
<h3 align=center>Set Up Notifiers</h3>
<p>If you want your library and browser to be updated automatically as
you commit revisions to the repository, you need to set up a
<em>
<a name="index-pt:0"></a>
notifier
</em>
:
</p><pre>
% mkdir {notify}
</pre>
<pre>
% cd {notify}
</pre>
<pre>
[ edit "=rules.archives" ]
</pre>
<p>As an example of the format of <em>
<a name="index-pt:1"></a>
=rules.archives
</em>
, here is the one I
use. In the documentation, long lines have been broken up with
continuation markers (<code>\</code>
), but in the real file, they are just very
long lines:
</p><pre>
lord@regexps.com--2002 \
mail-new-categories:lord \
mail-new-branches:lord \
mail-new-versions:lord \
mail-new-revisions:lord
</pre>
<pre>
lord@regexps.com--2002 \
noop:notify-library:lord \
noop:notify-library:lord \
noop:notify-library:lord \
notify-library:lord
</pre>
<pre>
lord@regexps.com--2002 \
noop:notify-library:lord \
noop:notify-library:lord \
noop:notify-library:lord \
notify-browser:lord
</pre>
<p>The first line defines rules for sending email when new revisions are
committed, or when categories, branches, or versions are created..
The second line updates the revision library when new revisions are
added to the library. The third line updates the browser whe new
revisions are added.
</p><p>Having set up your notifier directory, inform arch:
</p><pre>
% larch my-notifier "`pwd`/{notify}
</pre>
<p>See <a href="triggers.html#arch_Triggers">arch Triggers</a> for more information.
</p>
<a name="Get_to_Work"></a>
<h3 align=center>Get to Work</h3>
<p>Now you can create branches from other archives, import your own
original projects, and otherwise use the various commands documented
in this manual.
</p><p>Additional step by step directions can be found in the <em>
<a name="index-pt:2"></a>
docs/examples
</em>
directory of distributions of arch.
</p>
<small><i>arch: The arch Revision Control System
</i></small><br>
<a href="http://www.regexps.com">The Hackerlab at <code>regexps.com</code></a>
</body>
|
