Fossil SCM
Describe the Remark artifact used to record check-in remarks.
Commit
0e9021f800d718c9496d5effb26e723ad9f8281f
Parent
5e9e76733a68c15…
1 file changed
+73
-4
+73
-4
| --- www/fileformat.wiki | ||
| +++ www/fileformat.wiki | ||
| @@ -44,13 +44,14 @@ | ||
| 44 | 44 | <li> [#ctrl | Control Artifacts] </li> |
| 45 | 45 | <li> [#wikichng | Wiki Pages] </li> |
| 46 | 46 | <li> [#tktchng | Ticket Changes] </li> |
| 47 | 47 | <li> [#attachment | Attachments] </li> |
| 48 | 48 | <li> [#event | TechNotes] </li> |
| 49 | +<li> [#remark | Remarks] </li> | |
| 49 | 50 | </ul> |
| 50 | 51 | |
| 51 | -These seven artifact types are described in the following sections. | |
| 52 | +These eight artifact types are described in the following sections. | |
| 52 | 53 | |
| 53 | 54 | In the current implementation (as of 2009-01-25) the artifacts that |
| 54 | 55 | make up a fossil repository are stored as delta- and zlib-compressed |
| 55 | 56 | blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This |
| 56 | 57 | is an implementation detail and might change in a future release. For |
| @@ -530,13 +531,51 @@ | ||
| 530 | 531 | technote. The format of the W card is exactly the same as for a |
| 531 | 532 | [#wikichng | wiki artifact]. |
| 532 | 533 | |
| 533 | 534 | The Z card is the required checksum over the rest of the artifact. |
| 534 | 535 | |
| 536 | +<a name="remark"></a> | |
| 537 | +<h2>8.0 Remarks</h2> | |
| 538 | + | |
| 539 | +A remark artifact holds textual remarks that are added to a check-in. | |
| 540 | +Remarks can hold expanded commentary about the check-in, notes from | |
| 541 | +code-reviews, information about problems discovered in the check-in, | |
| 542 | +or other auxiliary textual information about the check-in. | |
| 543 | +The remark artifact is a new artifact added to this specification in | |
| 544 | +early 2017. | |
| 545 | +The following cards are allowed on an technote artifact: | |
| 546 | + | |
| 547 | +<blockquote> | |
| 548 | +<b>D</b> <i>time-and-date-stamp</i><br /> | |
| 549 | +<b>G</b> <i>checkin-uuid</i><br /> | |
| 550 | +<b>N</b> <i>mimetype</i><br /> | |
| 551 | +<b>U</b> <i>user-name</i><br /> | |
| 552 | +<b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b><br /> | |
| 553 | +<b>Z</b> <i>checksum</i> | |
| 554 | +</blockquote> | |
| 555 | + | |
| 556 | +A single D card is required to give the date and time when the | |
| 557 | +remark artifact was created. | |
| 558 | + | |
| 559 | +A single G card specifies the check-in to which the remark is | |
| 560 | +attached. | |
| 561 | + | |
| 562 | +The optional N card specifies the mimetype of the text of the technote | |
| 563 | +that is contained in the W card. If the N card is omitted, then the | |
| 564 | +W card text mimetype is assumed to be text/x-fossil, which is the | |
| 565 | +Fossil wiki format. | |
| 566 | + | |
| 567 | +A single W card provides wiki text for the document associated with the | |
| 568 | +technote. The format of the W card is exactly the same as for a | |
| 569 | +[#wikichng | wiki artifact]. | |
| 570 | + | |
| 571 | +The optional U card gives name of the user who entered the technote. | |
| 572 | + | |
| 573 | +The Z card is the required checksum over the rest of the artifact. | |
| 535 | 574 | |
| 536 | 575 | <a name="summary"></a> |
| 537 | -<h2>8.0 Card Summary</h2> | |
| 576 | +<h2>9.0 Card Summary</h2> | |
| 538 | 577 | |
| 539 | 578 | The following table summarizes the various kinds of cards that appear |
| 540 | 579 | on Fossil artifacts. A blank entry means that combination of card and |
| 541 | 580 | artifact is not legal. A number or range of numbers indicates the number |
| 542 | 581 | of times a card may (or must) appear in the corresponding artifact type. |
| @@ -544,29 +583,31 @@ | ||
| 544 | 583 | or more such cards are required. |
| 545 | 584 | |
| 546 | 585 | <table border=1 width="100%"> |
| 547 | 586 | <tr> |
| 548 | 587 | <th rowspan=2 valign=bottom>Card Format</th> |
| 549 | -<th colspan=7>Used By</th> | |
| 588 | +<th colspan=8>Used By</th> | |
| 550 | 589 | </tr> |
| 551 | 590 | <tr> |
| 552 | 591 | <th>Manifest</th> |
| 553 | 592 | <th>Cluster</th> |
| 554 | 593 | <th>Control</th> |
| 555 | 594 | <th>Wiki</th> |
| 556 | 595 | <th>Ticket</th> |
| 557 | 596 | <th>Attachment</th> |
| 558 | 597 | <th>Technote</th> |
| 598 | +<th>Remark</th> | |
| 559 | 599 | </tr> |
| 560 | 600 | <tr> |
| 561 | 601 | <td><b>A</b> <i>filename</i> <i>target</i> ?<i>source</i>?</td> |
| 562 | 602 | <td> </td> |
| 563 | 603 | <td> </td> |
| 564 | 604 | <td> </td> |
| 565 | 605 | <td> </td> |
| 566 | 606 | <td> </td> |
| 567 | 607 | <td align=center><b>1</b></td> |
| 608 | +<td> </td> | |
| 568 | 609 | <td> </td> |
| 569 | 610 | </tr> |
| 570 | 611 | <tr> |
| 571 | 612 | <td><b>B</b> <i>baseline</i></td> |
| 572 | 613 | <td align=center><b>0-1*</b></td> |
| @@ -574,26 +615,29 @@ | ||
| 574 | 615 | <td> </td> |
| 575 | 616 | <td> </td> |
| 576 | 617 | <td> </td> |
| 577 | 618 | <td> </td> |
| 578 | 619 | <td> </td> |
| 620 | +<td> </td> | |
| 579 | 621 | </tr> |
| 580 | -<tr><td> </td><td colspan='7'>* = Required for delta manifests</td></tr> | |
| 622 | +<tr><td> </td><td colspan='8'>* = Required for delta manifests</td></tr> | |
| 581 | 623 | <tr> |
| 582 | 624 | <td><b>C</b> <i>comment-text</i></td> |
| 583 | 625 | <td align=center><b>1</b></td> |
| 584 | 626 | <td> </td> |
| 585 | 627 | <td> </td> |
| 586 | 628 | <td> </td> |
| 587 | 629 | <td> </td> |
| 588 | 630 | <td align=center><b>0-1</b></td> |
| 589 | 631 | <td align=center><b>0-1</b></td> |
| 632 | +<td> </td> | |
| 590 | 633 | </tr> |
| 591 | 634 | <tr> |
| 592 | 635 | <td><b>D</b> <i>date-time-stamp</i></td> |
| 593 | 636 | <td align=center><b>1</b></td> |
| 594 | 637 | <td> </td> |
| 638 | +<td align=center><b>1</b></td> | |
| 595 | 639 | <td align=center><b>1</b></td> |
| 596 | 640 | <td align=center><b>1</b></td> |
| 597 | 641 | <td align=center><b>1</b></td> |
| 598 | 642 | <td align=center><b>1</b></td> |
| 599 | 643 | <td align=center><b>1</b></td> |
| @@ -605,10 +649,11 @@ | ||
| 605 | 649 | <td> </td> |
| 606 | 650 | <td> </td> |
| 607 | 651 | <td> </td> |
| 608 | 652 | <td> </td> |
| 609 | 653 | <td align=center><b>1</b></td> |
| 654 | +<td> </td> | |
| 610 | 655 | </tr> |
| 611 | 656 | <tr> |
| 612 | 657 | <td><b>F</b> <i>filename</i> ?<i>uuid</i>? ?<i>permissions</i>? ?<i>oldname</i>?</td> |
| 613 | 658 | <td align=center><b>0+</b></td> |
| 614 | 659 | <td> </td> |
| @@ -615,18 +660,31 @@ | ||
| 615 | 660 | <td> </td> |
| 616 | 661 | <td> </td> |
| 617 | 662 | <td> </td> |
| 618 | 663 | <td> </td> |
| 619 | 664 | <td> </td> |
| 665 | +<td> </td> | |
| 666 | +</tr> | |
| 667 | +<tr> | |
| 668 | +<td><b>G</b> <i>checkin-uuid</i></td> | |
| 669 | +<td> </td> | |
| 670 | +<td> </td> | |
| 671 | +<td> </td> | |
| 672 | +<td> </td> | |
| 673 | +<td> </td> | |
| 674 | +<td> </td> | |
| 675 | +<td> </td> | |
| 676 | +<td align=center><b>1</b></td> | |
| 620 | 677 | </tr> |
| 621 | 678 | <tr> |
| 622 | 679 | <td><b>J</b> <i>name</i> ?<i>value</i>?</td> |
| 623 | 680 | <td> </td> |
| 624 | 681 | <td> </td> |
| 625 | 682 | <td> </td> |
| 626 | 683 | <td> </td> |
| 627 | 684 | <td align=center><b>1+</b></td> |
| 685 | +<td> </td> | |
| 628 | 686 | <td> </td> |
| 629 | 687 | <td> </td> |
| 630 | 688 | </tr> |
| 631 | 689 | <tr> |
| 632 | 690 | <td><b>K</b> <i>ticket-uuid</i></td> |
| @@ -635,10 +693,11 @@ | ||
| 635 | 693 | <td> </td> |
| 636 | 694 | <td> </td> |
| 637 | 695 | <td align=center><b>1</b></td> |
| 638 | 696 | <td> </td> |
| 639 | 697 | <td> </td> |
| 698 | +<td> </td> | |
| 640 | 699 | </tr> |
| 641 | 700 | <tr> |
| 642 | 701 | <td><b>L</b> <i>wiki-title</i></td> |
| 643 | 702 | <td> </td> |
| 644 | 703 | <td> </td> |
| @@ -645,15 +704,17 @@ | ||
| 645 | 704 | <td> </td> |
| 646 | 705 | <td align=center><b>1</b></td> |
| 647 | 706 | <td> </td> |
| 648 | 707 | <td> </td> |
| 649 | 708 | <td> </td> |
| 709 | +<td> </td> | |
| 650 | 710 | </tr> |
| 651 | 711 | <tr> |
| 652 | 712 | <td><b>M</b> <i>uuid</i></td> |
| 653 | 713 | <td> </td> |
| 654 | 714 | <td align=center><b>1+</b></td> |
| 715 | +<td> </td> | |
| 655 | 716 | <td> </td> |
| 656 | 717 | <td> </td> |
| 657 | 718 | <td> </td> |
| 658 | 719 | <td> </td> |
| 659 | 720 | <td> </td> |
| @@ -665,10 +726,11 @@ | ||
| 665 | 726 | <td> </td> |
| 666 | 727 | <td align=center><b>0-1</b></td> |
| 667 | 728 | <td> </td> |
| 668 | 729 | <td align=center><b>0-1</b></td> |
| 669 | 730 | <td align=center><b>0-1</b></td> |
| 731 | +<td align=center><b>0-1</b></td> | |
| 670 | 732 | </tr> |
| 671 | 733 | <tr> |
| 672 | 734 | <td><b>P</b> <i>uuid ...</i></td> |
| 673 | 735 | <td align=center><b>0-1</b></td> |
| 674 | 736 | <td> </td> |
| @@ -675,14 +737,16 @@ | ||
| 675 | 737 | <td> </td> |
| 676 | 738 | <td align=center><b>0-1</b></td> |
| 677 | 739 | <td> </td> |
| 678 | 740 | <td> </td> |
| 679 | 741 | <td align=center><b>0-1</b></td> |
| 742 | +<td> </td> | |
| 680 | 743 | </tr> |
| 681 | 744 | <tr> |
| 682 | 745 | <td><b>Q</b> (<b>+</b>|<b>-</b>)<i>uuid</i> ?<i>uuid</i>?</td> |
| 683 | 746 | <td align=center><b>0+</b></td> |
| 747 | +<td> </td> | |
| 684 | 748 | <td> </td> |
| 685 | 749 | <td> </td> |
| 686 | 750 | <td> </td> |
| 687 | 751 | <td> </td> |
| 688 | 752 | <td> </td> |
| @@ -695,27 +759,30 @@ | ||
| 695 | 759 | <td> </td> |
| 696 | 760 | <td> </td> |
| 697 | 761 | <td> </td> |
| 698 | 762 | <td> </td> |
| 699 | 763 | <td> </td> |
| 764 | +<td> </td> | |
| 700 | 765 | <tr> |
| 701 | 766 | <td><b>T</b> (<b>+</b>|<b>*</b>|<b>-</b>)<i>tagname</i> <i>uuid</i> ?<i>value</i>?</td> |
| 702 | 767 | <td align=center><b>0+</b></td> |
| 703 | 768 | <td> </td> |
| 704 | 769 | <td align=center><b>1+</b></td> |
| 705 | 770 | <td> </td> |
| 706 | 771 | <td> </td> |
| 707 | 772 | <td> </td> |
| 708 | 773 | <td align=center><b>0+</b></td> |
| 774 | +<td> </td> | |
| 709 | 775 | </tr> |
| 710 | 776 | <tr> |
| 711 | 777 | <td><b>U</b> <i>username</i></td> |
| 712 | 778 | <td align=center><b>1</b></td> |
| 713 | 779 | <td> </td> |
| 714 | 780 | <td align=center><b>1</b></td> |
| 715 | 781 | <td align=center><b>1</b></td> |
| 716 | 782 | <td align=center><b>1</b></td> |
| 783 | +<td align=center><b>0-1</b></td> | |
| 717 | 784 | <td align=center><b>0-1</b></td> |
| 718 | 785 | <td align=center><b>0-1</b></td> |
| 719 | 786 | </tr> |
| 720 | 787 | <tr> |
| 721 | 788 | <td><b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b></td> |
| @@ -724,13 +791,15 @@ | ||
| 724 | 791 | <td> </td> |
| 725 | 792 | <td align=center><b>1</b></td> |
| 726 | 793 | <td> </td> |
| 727 | 794 | <td> </td> |
| 728 | 795 | <td align=center><b>1</b></td> |
| 796 | +<td align=center><b>1</b></td> | |
| 729 | 797 | </tr> |
| 730 | 798 | <tr> |
| 731 | 799 | <td><b>Z</b> <i>md5sum</i></td> |
| 800 | +<td align=center><b>1</b></td> | |
| 732 | 801 | <td align=center><b>1</b></td> |
| 733 | 802 | <td align=center><b>1</b></td> |
| 734 | 803 | <td align=center><b>1</b></td> |
| 735 | 804 | <td align=center><b>1</b></td> |
| 736 | 805 | <td align=center><b>1</b></td> |
| 737 | 806 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -44,13 +44,14 @@ | |
| 44 | <li> [#ctrl | Control Artifacts] </li> |
| 45 | <li> [#wikichng | Wiki Pages] </li> |
| 46 | <li> [#tktchng | Ticket Changes] </li> |
| 47 | <li> [#attachment | Attachments] </li> |
| 48 | <li> [#event | TechNotes] </li> |
| 49 | </ul> |
| 50 | |
| 51 | These seven artifact types are described in the following sections. |
| 52 | |
| 53 | In the current implementation (as of 2009-01-25) the artifacts that |
| 54 | make up a fossil repository are stored as delta- and zlib-compressed |
| 55 | blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This |
| 56 | is an implementation detail and might change in a future release. For |
| @@ -530,13 +531,51 @@ | |
| 530 | technote. The format of the W card is exactly the same as for a |
| 531 | [#wikichng | wiki artifact]. |
| 532 | |
| 533 | The Z card is the required checksum over the rest of the artifact. |
| 534 | |
| 535 | |
| 536 | <a name="summary"></a> |
| 537 | <h2>8.0 Card Summary</h2> |
| 538 | |
| 539 | The following table summarizes the various kinds of cards that appear |
| 540 | on Fossil artifacts. A blank entry means that combination of card and |
| 541 | artifact is not legal. A number or range of numbers indicates the number |
| 542 | of times a card may (or must) appear in the corresponding artifact type. |
| @@ -544,29 +583,31 @@ | |
| 544 | or more such cards are required. |
| 545 | |
| 546 | <table border=1 width="100%"> |
| 547 | <tr> |
| 548 | <th rowspan=2 valign=bottom>Card Format</th> |
| 549 | <th colspan=7>Used By</th> |
| 550 | </tr> |
| 551 | <tr> |
| 552 | <th>Manifest</th> |
| 553 | <th>Cluster</th> |
| 554 | <th>Control</th> |
| 555 | <th>Wiki</th> |
| 556 | <th>Ticket</th> |
| 557 | <th>Attachment</th> |
| 558 | <th>Technote</th> |
| 559 | </tr> |
| 560 | <tr> |
| 561 | <td><b>A</b> <i>filename</i> <i>target</i> ?<i>source</i>?</td> |
| 562 | <td> </td> |
| 563 | <td> </td> |
| 564 | <td> </td> |
| 565 | <td> </td> |
| 566 | <td> </td> |
| 567 | <td align=center><b>1</b></td> |
| 568 | <td> </td> |
| 569 | </tr> |
| 570 | <tr> |
| 571 | <td><b>B</b> <i>baseline</i></td> |
| 572 | <td align=center><b>0-1*</b></td> |
| @@ -574,26 +615,29 @@ | |
| 574 | <td> </td> |
| 575 | <td> </td> |
| 576 | <td> </td> |
| 577 | <td> </td> |
| 578 | <td> </td> |
| 579 | </tr> |
| 580 | <tr><td> </td><td colspan='7'>* = Required for delta manifests</td></tr> |
| 581 | <tr> |
| 582 | <td><b>C</b> <i>comment-text</i></td> |
| 583 | <td align=center><b>1</b></td> |
| 584 | <td> </td> |
| 585 | <td> </td> |
| 586 | <td> </td> |
| 587 | <td> </td> |
| 588 | <td align=center><b>0-1</b></td> |
| 589 | <td align=center><b>0-1</b></td> |
| 590 | </tr> |
| 591 | <tr> |
| 592 | <td><b>D</b> <i>date-time-stamp</i></td> |
| 593 | <td align=center><b>1</b></td> |
| 594 | <td> </td> |
| 595 | <td align=center><b>1</b></td> |
| 596 | <td align=center><b>1</b></td> |
| 597 | <td align=center><b>1</b></td> |
| 598 | <td align=center><b>1</b></td> |
| 599 | <td align=center><b>1</b></td> |
| @@ -605,10 +649,11 @@ | |
| 605 | <td> </td> |
| 606 | <td> </td> |
| 607 | <td> </td> |
| 608 | <td> </td> |
| 609 | <td align=center><b>1</b></td> |
| 610 | </tr> |
| 611 | <tr> |
| 612 | <td><b>F</b> <i>filename</i> ?<i>uuid</i>? ?<i>permissions</i>? ?<i>oldname</i>?</td> |
| 613 | <td align=center><b>0+</b></td> |
| 614 | <td> </td> |
| @@ -615,18 +660,31 @@ | |
| 615 | <td> </td> |
| 616 | <td> </td> |
| 617 | <td> </td> |
| 618 | <td> </td> |
| 619 | <td> </td> |
| 620 | </tr> |
| 621 | <tr> |
| 622 | <td><b>J</b> <i>name</i> ?<i>value</i>?</td> |
| 623 | <td> </td> |
| 624 | <td> </td> |
| 625 | <td> </td> |
| 626 | <td> </td> |
| 627 | <td align=center><b>1+</b></td> |
| 628 | <td> </td> |
| 629 | <td> </td> |
| 630 | </tr> |
| 631 | <tr> |
| 632 | <td><b>K</b> <i>ticket-uuid</i></td> |
| @@ -635,10 +693,11 @@ | |
| 635 | <td> </td> |
| 636 | <td> </td> |
| 637 | <td align=center><b>1</b></td> |
| 638 | <td> </td> |
| 639 | <td> </td> |
| 640 | </tr> |
| 641 | <tr> |
| 642 | <td><b>L</b> <i>wiki-title</i></td> |
| 643 | <td> </td> |
| 644 | <td> </td> |
| @@ -645,15 +704,17 @@ | |
| 645 | <td> </td> |
| 646 | <td align=center><b>1</b></td> |
| 647 | <td> </td> |
| 648 | <td> </td> |
| 649 | <td> </td> |
| 650 | </tr> |
| 651 | <tr> |
| 652 | <td><b>M</b> <i>uuid</i></td> |
| 653 | <td> </td> |
| 654 | <td align=center><b>1+</b></td> |
| 655 | <td> </td> |
| 656 | <td> </td> |
| 657 | <td> </td> |
| 658 | <td> </td> |
| 659 | <td> </td> |
| @@ -665,10 +726,11 @@ | |
| 665 | <td> </td> |
| 666 | <td align=center><b>0-1</b></td> |
| 667 | <td> </td> |
| 668 | <td align=center><b>0-1</b></td> |
| 669 | <td align=center><b>0-1</b></td> |
| 670 | </tr> |
| 671 | <tr> |
| 672 | <td><b>P</b> <i>uuid ...</i></td> |
| 673 | <td align=center><b>0-1</b></td> |
| 674 | <td> </td> |
| @@ -675,14 +737,16 @@ | |
| 675 | <td> </td> |
| 676 | <td align=center><b>0-1</b></td> |
| 677 | <td> </td> |
| 678 | <td> </td> |
| 679 | <td align=center><b>0-1</b></td> |
| 680 | </tr> |
| 681 | <tr> |
| 682 | <td><b>Q</b> (<b>+</b>|<b>-</b>)<i>uuid</i> ?<i>uuid</i>?</td> |
| 683 | <td align=center><b>0+</b></td> |
| 684 | <td> </td> |
| 685 | <td> </td> |
| 686 | <td> </td> |
| 687 | <td> </td> |
| 688 | <td> </td> |
| @@ -695,27 +759,30 @@ | |
| 695 | <td> </td> |
| 696 | <td> </td> |
| 697 | <td> </td> |
| 698 | <td> </td> |
| 699 | <td> </td> |
| 700 | <tr> |
| 701 | <td><b>T</b> (<b>+</b>|<b>*</b>|<b>-</b>)<i>tagname</i> <i>uuid</i> ?<i>value</i>?</td> |
| 702 | <td align=center><b>0+</b></td> |
| 703 | <td> </td> |
| 704 | <td align=center><b>1+</b></td> |
| 705 | <td> </td> |
| 706 | <td> </td> |
| 707 | <td> </td> |
| 708 | <td align=center><b>0+</b></td> |
| 709 | </tr> |
| 710 | <tr> |
| 711 | <td><b>U</b> <i>username</i></td> |
| 712 | <td align=center><b>1</b></td> |
| 713 | <td> </td> |
| 714 | <td align=center><b>1</b></td> |
| 715 | <td align=center><b>1</b></td> |
| 716 | <td align=center><b>1</b></td> |
| 717 | <td align=center><b>0-1</b></td> |
| 718 | <td align=center><b>0-1</b></td> |
| 719 | </tr> |
| 720 | <tr> |
| 721 | <td><b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b></td> |
| @@ -724,13 +791,15 @@ | |
| 724 | <td> </td> |
| 725 | <td align=center><b>1</b></td> |
| 726 | <td> </td> |
| 727 | <td> </td> |
| 728 | <td align=center><b>1</b></td> |
| 729 | </tr> |
| 730 | <tr> |
| 731 | <td><b>Z</b> <i>md5sum</i></td> |
| 732 | <td align=center><b>1</b></td> |
| 733 | <td align=center><b>1</b></td> |
| 734 | <td align=center><b>1</b></td> |
| 735 | <td align=center><b>1</b></td> |
| 736 | <td align=center><b>1</b></td> |
| 737 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -44,13 +44,14 @@ | |
| 44 | <li> [#ctrl | Control Artifacts] </li> |
| 45 | <li> [#wikichng | Wiki Pages] </li> |
| 46 | <li> [#tktchng | Ticket Changes] </li> |
| 47 | <li> [#attachment | Attachments] </li> |
| 48 | <li> [#event | TechNotes] </li> |
| 49 | <li> [#remark | Remarks] </li> |
| 50 | </ul> |
| 51 | |
| 52 | These eight artifact types are described in the following sections. |
| 53 | |
| 54 | In the current implementation (as of 2009-01-25) the artifacts that |
| 55 | make up a fossil repository are stored as delta- and zlib-compressed |
| 56 | blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This |
| 57 | is an implementation detail and might change in a future release. For |
| @@ -530,13 +531,51 @@ | |
| 531 | technote. The format of the W card is exactly the same as for a |
| 532 | [#wikichng | wiki artifact]. |
| 533 | |
| 534 | The Z card is the required checksum over the rest of the artifact. |
| 535 | |
| 536 | <a name="remark"></a> |
| 537 | <h2>8.0 Remarks</h2> |
| 538 | |
| 539 | A remark artifact holds textual remarks that are added to a check-in. |
| 540 | Remarks can hold expanded commentary about the check-in, notes from |
| 541 | code-reviews, information about problems discovered in the check-in, |
| 542 | or other auxiliary textual information about the check-in. |
| 543 | The remark artifact is a new artifact added to this specification in |
| 544 | early 2017. |
| 545 | The following cards are allowed on an technote artifact: |
| 546 | |
| 547 | <blockquote> |
| 548 | <b>D</b> <i>time-and-date-stamp</i><br /> |
| 549 | <b>G</b> <i>checkin-uuid</i><br /> |
| 550 | <b>N</b> <i>mimetype</i><br /> |
| 551 | <b>U</b> <i>user-name</i><br /> |
| 552 | <b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b><br /> |
| 553 | <b>Z</b> <i>checksum</i> |
| 554 | </blockquote> |
| 555 | |
| 556 | A single D card is required to give the date and time when the |
| 557 | remark artifact was created. |
| 558 | |
| 559 | A single G card specifies the check-in to which the remark is |
| 560 | attached. |
| 561 | |
| 562 | The optional N card specifies the mimetype of the text of the technote |
| 563 | that is contained in the W card. If the N card is omitted, then the |
| 564 | W card text mimetype is assumed to be text/x-fossil, which is the |
| 565 | Fossil wiki format. |
| 566 | |
| 567 | A single W card provides wiki text for the document associated with the |
| 568 | technote. The format of the W card is exactly the same as for a |
| 569 | [#wikichng | wiki artifact]. |
| 570 | |
| 571 | The optional U card gives name of the user who entered the technote. |
| 572 | |
| 573 | The Z card is the required checksum over the rest of the artifact. |
| 574 | |
| 575 | <a name="summary"></a> |
| 576 | <h2>9.0 Card Summary</h2> |
| 577 | |
| 578 | The following table summarizes the various kinds of cards that appear |
| 579 | on Fossil artifacts. A blank entry means that combination of card and |
| 580 | artifact is not legal. A number or range of numbers indicates the number |
| 581 | of times a card may (or must) appear in the corresponding artifact type. |
| @@ -544,29 +583,31 @@ | |
| 583 | or more such cards are required. |
| 584 | |
| 585 | <table border=1 width="100%"> |
| 586 | <tr> |
| 587 | <th rowspan=2 valign=bottom>Card Format</th> |
| 588 | <th colspan=8>Used By</th> |
| 589 | </tr> |
| 590 | <tr> |
| 591 | <th>Manifest</th> |
| 592 | <th>Cluster</th> |
| 593 | <th>Control</th> |
| 594 | <th>Wiki</th> |
| 595 | <th>Ticket</th> |
| 596 | <th>Attachment</th> |
| 597 | <th>Technote</th> |
| 598 | <th>Remark</th> |
| 599 | </tr> |
| 600 | <tr> |
| 601 | <td><b>A</b> <i>filename</i> <i>target</i> ?<i>source</i>?</td> |
| 602 | <td> </td> |
| 603 | <td> </td> |
| 604 | <td> </td> |
| 605 | <td> </td> |
| 606 | <td> </td> |
| 607 | <td align=center><b>1</b></td> |
| 608 | <td> </td> |
| 609 | <td> </td> |
| 610 | </tr> |
| 611 | <tr> |
| 612 | <td><b>B</b> <i>baseline</i></td> |
| 613 | <td align=center><b>0-1*</b></td> |
| @@ -574,26 +615,29 @@ | |
| 615 | <td> </td> |
| 616 | <td> </td> |
| 617 | <td> </td> |
| 618 | <td> </td> |
| 619 | <td> </td> |
| 620 | <td> </td> |
| 621 | </tr> |
| 622 | <tr><td> </td><td colspan='8'>* = Required for delta manifests</td></tr> |
| 623 | <tr> |
| 624 | <td><b>C</b> <i>comment-text</i></td> |
| 625 | <td align=center><b>1</b></td> |
| 626 | <td> </td> |
| 627 | <td> </td> |
| 628 | <td> </td> |
| 629 | <td> </td> |
| 630 | <td align=center><b>0-1</b></td> |
| 631 | <td align=center><b>0-1</b></td> |
| 632 | <td> </td> |
| 633 | </tr> |
| 634 | <tr> |
| 635 | <td><b>D</b> <i>date-time-stamp</i></td> |
| 636 | <td align=center><b>1</b></td> |
| 637 | <td> </td> |
| 638 | <td align=center><b>1</b></td> |
| 639 | <td align=center><b>1</b></td> |
| 640 | <td align=center><b>1</b></td> |
| 641 | <td align=center><b>1</b></td> |
| 642 | <td align=center><b>1</b></td> |
| 643 | <td align=center><b>1</b></td> |
| @@ -605,10 +649,11 @@ | |
| 649 | <td> </td> |
| 650 | <td> </td> |
| 651 | <td> </td> |
| 652 | <td> </td> |
| 653 | <td align=center><b>1</b></td> |
| 654 | <td> </td> |
| 655 | </tr> |
| 656 | <tr> |
| 657 | <td><b>F</b> <i>filename</i> ?<i>uuid</i>? ?<i>permissions</i>? ?<i>oldname</i>?</td> |
| 658 | <td align=center><b>0+</b></td> |
| 659 | <td> </td> |
| @@ -615,18 +660,31 @@ | |
| 660 | <td> </td> |
| 661 | <td> </td> |
| 662 | <td> </td> |
| 663 | <td> </td> |
| 664 | <td> </td> |
| 665 | <td> </td> |
| 666 | </tr> |
| 667 | <tr> |
| 668 | <td><b>G</b> <i>checkin-uuid</i></td> |
| 669 | <td> </td> |
| 670 | <td> </td> |
| 671 | <td> </td> |
| 672 | <td> </td> |
| 673 | <td> </td> |
| 674 | <td> </td> |
| 675 | <td> </td> |
| 676 | <td align=center><b>1</b></td> |
| 677 | </tr> |
| 678 | <tr> |
| 679 | <td><b>J</b> <i>name</i> ?<i>value</i>?</td> |
| 680 | <td> </td> |
| 681 | <td> </td> |
| 682 | <td> </td> |
| 683 | <td> </td> |
| 684 | <td align=center><b>1+</b></td> |
| 685 | <td> </td> |
| 686 | <td> </td> |
| 687 | <td> </td> |
| 688 | </tr> |
| 689 | <tr> |
| 690 | <td><b>K</b> <i>ticket-uuid</i></td> |
| @@ -635,10 +693,11 @@ | |
| 693 | <td> </td> |
| 694 | <td> </td> |
| 695 | <td align=center><b>1</b></td> |
| 696 | <td> </td> |
| 697 | <td> </td> |
| 698 | <td> </td> |
| 699 | </tr> |
| 700 | <tr> |
| 701 | <td><b>L</b> <i>wiki-title</i></td> |
| 702 | <td> </td> |
| 703 | <td> </td> |
| @@ -645,15 +704,17 @@ | |
| 704 | <td> </td> |
| 705 | <td align=center><b>1</b></td> |
| 706 | <td> </td> |
| 707 | <td> </td> |
| 708 | <td> </td> |
| 709 | <td> </td> |
| 710 | </tr> |
| 711 | <tr> |
| 712 | <td><b>M</b> <i>uuid</i></td> |
| 713 | <td> </td> |
| 714 | <td align=center><b>1+</b></td> |
| 715 | <td> </td> |
| 716 | <td> </td> |
| 717 | <td> </td> |
| 718 | <td> </td> |
| 719 | <td> </td> |
| 720 | <td> </td> |
| @@ -665,10 +726,11 @@ | |
| 726 | <td> </td> |
| 727 | <td align=center><b>0-1</b></td> |
| 728 | <td> </td> |
| 729 | <td align=center><b>0-1</b></td> |
| 730 | <td align=center><b>0-1</b></td> |
| 731 | <td align=center><b>0-1</b></td> |
| 732 | </tr> |
| 733 | <tr> |
| 734 | <td><b>P</b> <i>uuid ...</i></td> |
| 735 | <td align=center><b>0-1</b></td> |
| 736 | <td> </td> |
| @@ -675,14 +737,16 @@ | |
| 737 | <td> </td> |
| 738 | <td align=center><b>0-1</b></td> |
| 739 | <td> </td> |
| 740 | <td> </td> |
| 741 | <td align=center><b>0-1</b></td> |
| 742 | <td> </td> |
| 743 | </tr> |
| 744 | <tr> |
| 745 | <td><b>Q</b> (<b>+</b>|<b>-</b>)<i>uuid</i> ?<i>uuid</i>?</td> |
| 746 | <td align=center><b>0+</b></td> |
| 747 | <td> </td> |
| 748 | <td> </td> |
| 749 | <td> </td> |
| 750 | <td> </td> |
| 751 | <td> </td> |
| 752 | <td> </td> |
| @@ -695,27 +759,30 @@ | |
| 759 | <td> </td> |
| 760 | <td> </td> |
| 761 | <td> </td> |
| 762 | <td> </td> |
| 763 | <td> </td> |
| 764 | <td> </td> |
| 765 | <tr> |
| 766 | <td><b>T</b> (<b>+</b>|<b>*</b>|<b>-</b>)<i>tagname</i> <i>uuid</i> ?<i>value</i>?</td> |
| 767 | <td align=center><b>0+</b></td> |
| 768 | <td> </td> |
| 769 | <td align=center><b>1+</b></td> |
| 770 | <td> </td> |
| 771 | <td> </td> |
| 772 | <td> </td> |
| 773 | <td align=center><b>0+</b></td> |
| 774 | <td> </td> |
| 775 | </tr> |
| 776 | <tr> |
| 777 | <td><b>U</b> <i>username</i></td> |
| 778 | <td align=center><b>1</b></td> |
| 779 | <td> </td> |
| 780 | <td align=center><b>1</b></td> |
| 781 | <td align=center><b>1</b></td> |
| 782 | <td align=center><b>1</b></td> |
| 783 | <td align=center><b>0-1</b></td> |
| 784 | <td align=center><b>0-1</b></td> |
| 785 | <td align=center><b>0-1</b></td> |
| 786 | </tr> |
| 787 | <tr> |
| 788 | <td><b>W</b> <i>size</i> <b>\n</b> <i>text</i> <b>\n</b></td> |
| @@ -724,13 +791,15 @@ | |
| 791 | <td> </td> |
| 792 | <td align=center><b>1</b></td> |
| 793 | <td> </td> |
| 794 | <td> </td> |
| 795 | <td align=center><b>1</b></td> |
| 796 | <td align=center><b>1</b></td> |
| 797 | </tr> |
| 798 | <tr> |
| 799 | <td><b>Z</b> <i>md5sum</i></td> |
| 800 | <td align=center><b>1</b></td> |
| 801 | <td align=center><b>1</b></td> |
| 802 | <td align=center><b>1</b></td> |
| 803 | <td align=center><b>1</b></td> |
| 804 | <td align=center><b>1</b></td> |
| 805 | <td align=center><b>1</b></td> |
| 806 |