Fossil SCM
Update the sync protocol document.
Commit
55cd6153dee1cb36e973dd58df0e4c6c81769f412e2afc0713e1800c130585c1
Parent
6ae97be7a7edbca…
1 file changed
+29
-6
+29
-6
| --- www/sync.wiki | ||
| +++ www/sync.wiki | ||
| @@ -498,60 +498,73 @@ | ||
| 498 | 498 | |
| 499 | 499 | <blockquote> |
| 500 | 500 | <b>reqconfig</b> <i>configuration-name</i> |
| 501 | 501 | </blockquote> |
| 502 | 502 | |
| 503 | -<p>As of [/timeline?r=trunk&c=2015-03-19+03%3A57%3A46&n=20|2015-03-19], the configuration-name must be one of the | |
| 503 | +<p>As of 2018-06-04, the configuration-name must be one of the | |
| 504 | 504 | following values: |
| 505 | 505 | |
| 506 | 506 | <table border=0 align="center"> |
| 507 | 507 | <tr><td valign="top"> |
| 508 | 508 | <ul> |
| 509 | 509 | <li> css |
| 510 | 510 | <li> header |
| 511 | 511 | <li> footer |
| 512 | +<li> details | |
| 512 | 513 | <li> logo-mimetype |
| 513 | 514 | <li> logo-image |
| 514 | 515 | <li> background-mimetype |
| 515 | 516 | <li> background-image |
| 516 | 517 | <li> index-page |
| 517 | 518 | <li> timeline-block-markup |
| 518 | 519 | <li> timeline-max-comment |
| 519 | 520 | <li> timeline-plaintext |
| 520 | -<ul></td><td valign="top"><ul> | |
| 521 | 521 | <li> adunit |
| 522 | 522 | <li> adunit-omit-if-admin |
| 523 | 523 | <li> adunit-omit-if-user |
| 524 | -<li> white-foreground | |
| 524 | +<ul></td><td valign="top"><ul> | |
| 525 | +<li> th1-docs | |
| 526 | +<li> th1-hooks | |
| 527 | +<li> th1-setup | |
| 528 | +<li> tcl | |
| 529 | +<li> tcl-setup | |
| 525 | 530 | <li> project-name |
| 526 | 531 | <li> short-project-name |
| 527 | 532 | <li> project-description |
| 528 | 533 | <li> index-page |
| 529 | 534 | <li> manifest |
| 530 | 535 | <li> binary-glob |
| 531 | 536 | <li> clean-glob |
| 532 | -<ul></td><td valign="top"><ul> | |
| 533 | 537 | <li> ignore-glob |
| 534 | 538 | <li> keep-glob |
| 535 | 539 | <li> crlf-glob |
| 540 | +<ul></td><td valign="top"><ul> | |
| 536 | 541 | <li> crnl-glob |
| 537 | 542 | <li> encoding-glob |
| 538 | 543 | <li> empty-dirs |
| 539 | 544 | <li> allow-symlinks |
| 540 | 545 | <li> dotfiles |
| 546 | +<li> parent-project-code | |
| 547 | +<li> parent-projet-name | |
| 548 | +<li> hash-policy | |
| 549 | +<li> mv-rm-files | |
| 541 | 550 | <li> ticket-table |
| 542 | 551 | <li> ticket-common |
| 543 | 552 | <li> ticket-change |
| 544 | 553 | <li> ticket-newpage |
| 545 | -<ul></td><td valign="top"><ul> | |
| 546 | 554 | <li> ticket-viewpage |
| 547 | 555 | <li> ticket-editpage |
| 556 | +<ul></td><td valign="top"><ul> | |
| 548 | 557 | <li> ticket-reportlist |
| 549 | 558 | <li> ticket-report-template |
| 550 | 559 | <li> ticket-key-template |
| 551 | 560 | <li> ticket-title-expr |
| 552 | 561 | <li> ticket-closed-expr |
| 562 | +<li> xfer-common-script | |
| 563 | +<li> xfer-push-script | |
| 564 | +<li> xfer-commit-script | |
| 565 | +<li> xfer-ticket-script | |
| 553 | 566 | <li> @reportfmt |
| 554 | 567 | <li> @user |
| 555 | 568 | <li> @concealed |
| 556 | 569 | <li> @shun |
| 557 | 570 | </ul></td></tr> |
| @@ -672,11 +685,11 @@ | ||
| 672 | 685 | <h3>3.12 Comment Cards</h3> |
| 673 | 686 | |
| 674 | 687 | <p>Any card that begins with "#" (ASCII 0x23) is a comment card and |
| 675 | 688 | is silently ignored.</p> |
| 676 | 689 | |
| 677 | -<h3>3.13 Error Cards</h3> | |
| 690 | +<h3>3.13 Message and Error Cards</h3> | |
| 678 | 691 | |
| 679 | 692 | <p>If the server discovers anything wrong with a request, it generates |
| 680 | 693 | an error card in its reply. When the client sees the error card, |
| 681 | 694 | it displays an error message to the user and aborts the sync |
| 682 | 695 | operation. An error card looks like this:</p> |
| @@ -691,10 +704,19 @@ | ||
| 691 | 704 | newline (ASCII 0x0a) is "\n" (ASCII 0x6C, x6E). A backslash |
| 692 | 705 | (ASCII 0x5C) is represented as two backslashes "\\". Apart from |
| 693 | 706 | space and newline, no other whitespace characters nor any |
| 694 | 707 | unprintable characters are allowed in |
| 695 | 708 | the error message.</p> |
| 709 | + | |
| 710 | +<p>The server can also send a message card that also prints a | |
| 711 | +message on the client console, but which is not an error: | |
| 712 | + | |
| 713 | +<blockquote> | |
| 714 | +<b>message</b> <i>message-text</i> | |
| 715 | +</blockquote> | |
| 716 | + | |
| 717 | +<p>The message-text uses the same format as an error message. | |
| 696 | 718 | |
| 697 | 719 | <h3>3.14 Unknown Cards</h3> |
| 698 | 720 | |
| 699 | 721 | <p>If either the client or the server sees a card that is not |
| 700 | 722 | described above, then it generates an error and aborts.</p> |
| @@ -913,10 +935,11 @@ | ||
| 913 | 935 | <li> <b>cookie</b> <i>cookie-text</i> |
| 914 | 936 | <li> <b>reqconfig</b> <i>parameter-name</i> |
| 915 | 937 | <li> <b>config</b> <i>parameter-name size</i> <b>\n</b> <i>content</i> |
| 916 | 938 | <li> <b>pragma</b> <i>name</i> <i>value...</i> |
| 917 | 939 | <li> <b>error</b> <i>error-message</i> |
| 940 | + <li> <b>message</b> <i>text-messate</i> | |
| 918 | 941 | <li> <b>#</b> <i>arbitrary-text...</i> |
| 919 | 942 | </ul> |
| 920 | 943 | <li>Phantoms are artifacts that a repository knows exist but does not possess. |
| 921 | 944 | <li>Clusters are artifacts that contain IDs of other artifacts. |
| 922 | 945 | <li>Clusters are created automatically on the server during a pull. |
| 923 | 946 |
| --- www/sync.wiki | |
| +++ www/sync.wiki | |
| @@ -498,60 +498,73 @@ | |
| 498 | |
| 499 | <blockquote> |
| 500 | <b>reqconfig</b> <i>configuration-name</i> |
| 501 | </blockquote> |
| 502 | |
| 503 | <p>As of [/timeline?r=trunk&c=2015-03-19+03%3A57%3A46&n=20|2015-03-19], the configuration-name must be one of the |
| 504 | following values: |
| 505 | |
| 506 | <table border=0 align="center"> |
| 507 | <tr><td valign="top"> |
| 508 | <ul> |
| 509 | <li> css |
| 510 | <li> header |
| 511 | <li> footer |
| 512 | <li> logo-mimetype |
| 513 | <li> logo-image |
| 514 | <li> background-mimetype |
| 515 | <li> background-image |
| 516 | <li> index-page |
| 517 | <li> timeline-block-markup |
| 518 | <li> timeline-max-comment |
| 519 | <li> timeline-plaintext |
| 520 | <ul></td><td valign="top"><ul> |
| 521 | <li> adunit |
| 522 | <li> adunit-omit-if-admin |
| 523 | <li> adunit-omit-if-user |
| 524 | <li> white-foreground |
| 525 | <li> project-name |
| 526 | <li> short-project-name |
| 527 | <li> project-description |
| 528 | <li> index-page |
| 529 | <li> manifest |
| 530 | <li> binary-glob |
| 531 | <li> clean-glob |
| 532 | <ul></td><td valign="top"><ul> |
| 533 | <li> ignore-glob |
| 534 | <li> keep-glob |
| 535 | <li> crlf-glob |
| 536 | <li> crnl-glob |
| 537 | <li> encoding-glob |
| 538 | <li> empty-dirs |
| 539 | <li> allow-symlinks |
| 540 | <li> dotfiles |
| 541 | <li> ticket-table |
| 542 | <li> ticket-common |
| 543 | <li> ticket-change |
| 544 | <li> ticket-newpage |
| 545 | <ul></td><td valign="top"><ul> |
| 546 | <li> ticket-viewpage |
| 547 | <li> ticket-editpage |
| 548 | <li> ticket-reportlist |
| 549 | <li> ticket-report-template |
| 550 | <li> ticket-key-template |
| 551 | <li> ticket-title-expr |
| 552 | <li> ticket-closed-expr |
| 553 | <li> @reportfmt |
| 554 | <li> @user |
| 555 | <li> @concealed |
| 556 | <li> @shun |
| 557 | </ul></td></tr> |
| @@ -672,11 +685,11 @@ | |
| 672 | <h3>3.12 Comment Cards</h3> |
| 673 | |
| 674 | <p>Any card that begins with "#" (ASCII 0x23) is a comment card and |
| 675 | is silently ignored.</p> |
| 676 | |
| 677 | <h3>3.13 Error Cards</h3> |
| 678 | |
| 679 | <p>If the server discovers anything wrong with a request, it generates |
| 680 | an error card in its reply. When the client sees the error card, |
| 681 | it displays an error message to the user and aborts the sync |
| 682 | operation. An error card looks like this:</p> |
| @@ -691,10 +704,19 @@ | |
| 691 | newline (ASCII 0x0a) is "\n" (ASCII 0x6C, x6E). A backslash |
| 692 | (ASCII 0x5C) is represented as two backslashes "\\". Apart from |
| 693 | space and newline, no other whitespace characters nor any |
| 694 | unprintable characters are allowed in |
| 695 | the error message.</p> |
| 696 | |
| 697 | <h3>3.14 Unknown Cards</h3> |
| 698 | |
| 699 | <p>If either the client or the server sees a card that is not |
| 700 | described above, then it generates an error and aborts.</p> |
| @@ -913,10 +935,11 @@ | |
| 913 | <li> <b>cookie</b> <i>cookie-text</i> |
| 914 | <li> <b>reqconfig</b> <i>parameter-name</i> |
| 915 | <li> <b>config</b> <i>parameter-name size</i> <b>\n</b> <i>content</i> |
| 916 | <li> <b>pragma</b> <i>name</i> <i>value...</i> |
| 917 | <li> <b>error</b> <i>error-message</i> |
| 918 | <li> <b>#</b> <i>arbitrary-text...</i> |
| 919 | </ul> |
| 920 | <li>Phantoms are artifacts that a repository knows exist but does not possess. |
| 921 | <li>Clusters are artifacts that contain IDs of other artifacts. |
| 922 | <li>Clusters are created automatically on the server during a pull. |
| 923 |
| --- www/sync.wiki | |
| +++ www/sync.wiki | |
| @@ -498,60 +498,73 @@ | |
| 498 | |
| 499 | <blockquote> |
| 500 | <b>reqconfig</b> <i>configuration-name</i> |
| 501 | </blockquote> |
| 502 | |
| 503 | <p>As of 2018-06-04, the configuration-name must be one of the |
| 504 | following values: |
| 505 | |
| 506 | <table border=0 align="center"> |
| 507 | <tr><td valign="top"> |
| 508 | <ul> |
| 509 | <li> css |
| 510 | <li> header |
| 511 | <li> footer |
| 512 | <li> details |
| 513 | <li> logo-mimetype |
| 514 | <li> logo-image |
| 515 | <li> background-mimetype |
| 516 | <li> background-image |
| 517 | <li> index-page |
| 518 | <li> timeline-block-markup |
| 519 | <li> timeline-max-comment |
| 520 | <li> timeline-plaintext |
| 521 | <li> adunit |
| 522 | <li> adunit-omit-if-admin |
| 523 | <li> adunit-omit-if-user |
| 524 | <ul></td><td valign="top"><ul> |
| 525 | <li> th1-docs |
| 526 | <li> th1-hooks |
| 527 | <li> th1-setup |
| 528 | <li> tcl |
| 529 | <li> tcl-setup |
| 530 | <li> project-name |
| 531 | <li> short-project-name |
| 532 | <li> project-description |
| 533 | <li> index-page |
| 534 | <li> manifest |
| 535 | <li> binary-glob |
| 536 | <li> clean-glob |
| 537 | <li> ignore-glob |
| 538 | <li> keep-glob |
| 539 | <li> crlf-glob |
| 540 | <ul></td><td valign="top"><ul> |
| 541 | <li> crnl-glob |
| 542 | <li> encoding-glob |
| 543 | <li> empty-dirs |
| 544 | <li> allow-symlinks |
| 545 | <li> dotfiles |
| 546 | <li> parent-project-code |
| 547 | <li> parent-projet-name |
| 548 | <li> hash-policy |
| 549 | <li> mv-rm-files |
| 550 | <li> ticket-table |
| 551 | <li> ticket-common |
| 552 | <li> ticket-change |
| 553 | <li> ticket-newpage |
| 554 | <li> ticket-viewpage |
| 555 | <li> ticket-editpage |
| 556 | <ul></td><td valign="top"><ul> |
| 557 | <li> ticket-reportlist |
| 558 | <li> ticket-report-template |
| 559 | <li> ticket-key-template |
| 560 | <li> ticket-title-expr |
| 561 | <li> ticket-closed-expr |
| 562 | <li> xfer-common-script |
| 563 | <li> xfer-push-script |
| 564 | <li> xfer-commit-script |
| 565 | <li> xfer-ticket-script |
| 566 | <li> @reportfmt |
| 567 | <li> @user |
| 568 | <li> @concealed |
| 569 | <li> @shun |
| 570 | </ul></td></tr> |
| @@ -672,11 +685,11 @@ | |
| 685 | <h3>3.12 Comment Cards</h3> |
| 686 | |
| 687 | <p>Any card that begins with "#" (ASCII 0x23) is a comment card and |
| 688 | is silently ignored.</p> |
| 689 | |
| 690 | <h3>3.13 Message and Error Cards</h3> |
| 691 | |
| 692 | <p>If the server discovers anything wrong with a request, it generates |
| 693 | an error card in its reply. When the client sees the error card, |
| 694 | it displays an error message to the user and aborts the sync |
| 695 | operation. An error card looks like this:</p> |
| @@ -691,10 +704,19 @@ | |
| 704 | newline (ASCII 0x0a) is "\n" (ASCII 0x6C, x6E). A backslash |
| 705 | (ASCII 0x5C) is represented as two backslashes "\\". Apart from |
| 706 | space and newline, no other whitespace characters nor any |
| 707 | unprintable characters are allowed in |
| 708 | the error message.</p> |
| 709 | |
| 710 | <p>The server can also send a message card that also prints a |
| 711 | message on the client console, but which is not an error: |
| 712 | |
| 713 | <blockquote> |
| 714 | <b>message</b> <i>message-text</i> |
| 715 | </blockquote> |
| 716 | |
| 717 | <p>The message-text uses the same format as an error message. |
| 718 | |
| 719 | <h3>3.14 Unknown Cards</h3> |
| 720 | |
| 721 | <p>If either the client or the server sees a card that is not |
| 722 | described above, then it generates an error and aborts.</p> |
| @@ -913,10 +935,11 @@ | |
| 935 | <li> <b>cookie</b> <i>cookie-text</i> |
| 936 | <li> <b>reqconfig</b> <i>parameter-name</i> |
| 937 | <li> <b>config</b> <i>parameter-name size</i> <b>\n</b> <i>content</i> |
| 938 | <li> <b>pragma</b> <i>name</i> <i>value...</i> |
| 939 | <li> <b>error</b> <i>error-message</i> |
| 940 | <li> <b>message</b> <i>text-messate</i> |
| 941 | <li> <b>#</b> <i>arbitrary-text...</i> |
| 942 | </ul> |
| 943 | <li>Phantoms are artifacts that a repository knows exist but does not possess. |
| 944 | <li>Clusters are artifacts that contain IDs of other artifacts. |
| 945 | <li>Clusters are created automatically on the server during a pull. |
| 946 |