| ︙ | | | ︙ | |
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
<ul>
<li> [#manifest | Manifests] </li>
<li> [#cluster | Clusters] </li>
<li> [#ctrl | Control Artifacts] </li>
<li> [#wikichng | Wiki Pages] </li>
<li> [#tktchng | Ticket Changes] </li>
<li> [#attachment | Attachments] </li>
</ul>
These five artifact types are described in the sequel.
In the current implementation (as of 2009-01-25) the artifacts that
make up a fossil repository are stored in in as delta- and zlib-compressed
blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This
|
>
|
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<ul>
<li> [#manifest | Manifests] </li>
<li> [#cluster | Clusters] </li>
<li> [#ctrl | Control Artifacts] </li>
<li> [#wikichng | Wiki Pages] </li>
<li> [#tktchng | Ticket Changes] </li>
<li> [#attachment | Attachments] </li>
<li> [#event | Events] </li>
</ul>
These five artifact types are described in the sequel.
In the current implementation (as of 2009-01-25) the artifacts that
make up a fossil repository are stored in in as delta- and zlib-compressed
blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This
|
| ︙ | | | ︙ | |
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
the manifest itself) in strict sorted lexicographical order,
take the pathname of the file relative to the root of the
repository, append a single space (ASCII 0x20), the
size of the file in ASCII decimal, a single newline
character (ASCII 0x0A), and the complete text of the file.
Compute the MD5 checksum of the result.
A manifest might contain one or more T-cards used to set tags or
properties on the check-in. The format of the T-card is the same as
|
|
>
|
|
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
the manifest itself) in strict sorted lexicographical order,
take the pathname of the file relative to the root of the
repository, append a single space (ASCII 0x20), the
size of the file in ASCII decimal, a single newline
character (ASCII 0x0A), and the complete text of the file.
Compute the MD5 checksum of the result.
A manifest might contain one or more T-cards used to set
[./branching.wiki#tags | tags or properties]
on the check-in. The format of the T-card is the same as
described in <i>Control Artifacts</i> section below, except that the
second argument is the single characcter "<b>*</b>" instead of an
artifact ID. The <b>*</b> in place of the artifact ID indicates that
the tag or property applies to the current artifact. It is not
possible to encode the current artifact ID as part of an artifact,
since the act of inserting the artifact ID would change the artifact ID,
hence a <b>*</b> is used to represent "self". T-cards are typically
|
| ︙ | | | ︙ | |
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
one or more T cards. No other cards or other text is
allowed in a control artifact. Control artifacts might be PGP
clearsigned.
The D card and the Z card of a control artifact are the same
as in a manifest.
The T card represents a "tag" or property that is applied to
|
>
|
|
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
one or more T cards. No other cards or other text is
allowed in a control artifact. Control artifacts might be PGP
clearsigned.
The D card and the Z card of a control artifact are the same
as in a manifest.
The T card represents a [./branching.wiki#tags | tag or property]
that is applied to
some other artifact. The T card has two or three values. The
second argument is the 40 character lowercase artifact ID of the artifact
to which the tag is to be applied. The
first value is the tag name. The first character of the tag
is either "+", "-", or "*". A "+" means the tag should be added
to the artifact. The "-" means the tag should be removed.
The "*" character means the tag should be added to the artifact
|
| ︙ | | | ︙ | |
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
The W card is used to specify the text of the wiki page. The
argument to the W card is an integer which is the number of bytes
of text in the wiki page. That text follows the newline character
that terminates the W card. The wiki text is always followed by one
extra newline.
An example wiki artifact can be seen
[/artifact/7b2f5fd0e0 | here].
<a name="tktchng"></a>
<h2>5.0 Ticket Changes</h2>
A ticket-change artifact represents a change to a trouble ticket.
The following cards are allowed on a ticket change artifact:
|
|
|
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
The W card is used to specify the text of the wiki page. The
argument to the W card is an integer which is the number of bytes
of text in the wiki page. That text follows the newline character
that terminates the W card. The wiki text is always followed by one
extra newline.
An example wiki artifact can be seen
[/artifact/7b2f5fd0e0?txt=1 | here].
<a name="tktchng"></a>
<h2>5.0 Ticket Changes</h2>
A ticket-change artifact represents a change to a trouble ticket.
The following cards are allowed on a ticket change artifact:
|
| ︙ | | | ︙ | |
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
|
<b>D</b> <i>time-and-date-stamp</i><br />
<b>U</b> <i>user-name</i><br />
<b>Z</b> <i>checksum</i>
</blockquote>
The A card specifies a filename for the attachment in its first argument.
The second argument to the A card is the name
of the wiki page or ticket to which the attachment is connected. The
third argument is either missing or else it is the 40-character artifact
ID of the attachment itself. A missing third argument means that the
attachment should be deleted.
The C card is an optional comment describing what the attachment is about.
The C card is optional, but there can only be one.
A single D card is required to give the date and time when the attachment
was applied.
A single U card gives the name of the user to added the attachment.
If an attachment is added anonymously, then the U card may be omitted.
The Z card is the usual checksum over the rest of the attachment artifact.
<a name="summary"></a>
<h2>7.0 Card Summary</h2>
The following table summaries the various kinds of cards that
appear on Fossil artifacts:
<table border=1 width="100%">
<tr>
<th rowspan=2 valign=bottom>Card Format</th>
<th colspan=6>Used By</th>
</tr>
<tr>
<th>Manifest</th>
<th>Cluster</th>
<th>Control</th>
<th>Wiki</th>
<th>Ticket</th>
<th>Attachment</th>
</tr>
<tr>
<td><b>A</b> <i>filename target source</i></td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>C</b> <i>coment-text</i></td>
<td align=center><b>X</b></td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>D</b> <i>date-time-stamp</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>F</b> <i>filename uuid permissions oldname</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>J</b> <i>name value</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
</tr>
<tr>
<td><b>K</b> <i>ticket-uuid</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
</tr>
<tr>
<td><b>L</b> <i>wiki-title</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>M</b> <i>uuid</i></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>P</b> <i>uuid ...</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>R</b> <i>md5sum</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<tr>
<td><b>T</b> (<b>+</b>|<b>*</b>|<b>-</b>)<i>tagname uuid value</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>U</b> <i>username</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>W</b> <i>size</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>Z</b> <i>md5sum</i></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
</table>
|
|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
|
>
>
|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
<b>D</b> <i>time-and-date-stamp</i><br />
<b>U</b> <i>user-name</i><br />
<b>Z</b> <i>checksum</i>
</blockquote>
The A card specifies a filename for the attachment in its first argument.
The second argument to the A card is the name
of the wiki page or ticket or event to which the attachment is connected. The
third argument is either missing or else it is the 40-character artifact
ID of the attachment itself. A missing third argument means that the
attachment should be deleted.
The C card is an optional comment describing what the attachment is about.
The C card is optional, but there can only be one.
A single D card is required to give the date and time when the attachment
was applied.
A single U card gives the name of the user to added the attachment.
If an attachment is added anonymously, then the U card may be omitted.
The Z card is the usual checksum over the rest of the attachment artifact.
<a name="event"></a>
<h2>7.0 Events</h2>
An event artifact associates a timeline comment and a page of text
(similar to a wiki page) with a point in time. Events can be used
to record project milestones, release notes, blog entries, process
checkpoints, or news articles.
The following cards are allowed on an event artifact:
<blockquote>
<b>C</b> <i>comment</i><br>
<b>D</b> <i>time-and-date-stamp</i><br />
<b>E</b> <i>event-time</i> <i>event-id</i><br />
<b>P</b> <i>parent-artifact-id</i>+<br />
<b>U</b> <i>user-name</i><br />
<b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b><br />
<b>Z</b> <i>checksum</i>
</blockquote>
The C card contains text that is displayed on the timeline for the
event. Exactly one C card is required on an event artifact.
A single D card is required to give the date and time when the
event artifact was created. This is different from the time at which
the event occurs.
A single E card gives the time of the event (the point on the timeline
where the event is displayed) and a unique identifier for the event.
When there are multiple artifacts with the same event-id, the one with
the most recent D card is the only one used.
The option P card specifies a prior event with the same event-id from
which the current event is an edit. The P card is a hint to the system
that it might be space efficient to store one event as a delta of the
other.
A single U card gives the name of the user to added the attachment.
A single W card provides wiki text for the document associated with the
event. The format of the W card is exactly the same as for a wiki
artifact.
The Z card is the usual checksum over the rest of the attachment artifact.
<a name="summary"></a>
<h2>8.0 Card Summary</h2>
The following table summaries the various kinds of cards that
appear on Fossil artifacts:
<table border=1 width="100%">
<tr>
<th rowspan=2 valign=bottom>Card Format</th>
<th colspan=7>Used By</th>
</tr>
<tr>
<th>Manifest</th>
<th>Cluster</th>
<th>Control</th>
<th>Wiki</th>
<th>Ticket</th>
<th>Attachment</th>
<th>Event</th>
</tr>
<tr>
<td><b>A</b> <i>filename target source</i></td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td align=center><b>X</b></td>
<td> </td>
</tr>
<tr>
<td><b>C</b> <i>comment-text</i></td>
<td align=center><b>X</b></td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>D</b> <i>date-time-stamp</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>E</b> <i>event-time event-id</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>F</b> <i>filename uuid permissions oldname</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>J</b> <i>name value</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>K</b> <i>ticket-uuid</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>L</b> <i>wiki-title</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>M</b> <i>uuid</i></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>P</b> <i>uuid ...</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>R</b> <i>md5sum</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<tr>
<td><b>T</b> (<b>+</b>|<b>*</b>|<b>-</b>)<i>tagname uuid value</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
</tr>
<tr>
<td><b>U</b> <i>username</i></td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>W</b> <i>size</i></td>
<td align=center> </td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
<td align=center> </td>
<td align=center> </td>
<td align=center><b>X</b></td>
</tr>
<tr>
<td><b>Z</b> <i>md5sum</i></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
<td align=center><b>X</b></td>
</tr>
</table>
|