Fossil SCM
Update the file format documentation to make it clear that a Z-card is required on all artifacts.
Commit
51c3f3b6709bf630b9016f9fd2011fe816ad90cd
Parent
a48c661d9a06a5e…
1 file changed
+8
-8
+8
-8
| --- www/fileformat.wiki | ||
| +++ www/fileformat.wiki | ||
| @@ -200,14 +200,14 @@ | ||
| 200 | 200 | Each manifest has a single U-card. The argument to the U-card is |
| 201 | 201 | the login of the user who created the manifest. The login name |
| 202 | 202 | is encoded using the same character escapes as is used for the |
| 203 | 203 | check-in comment argument to the C-card. |
| 204 | 204 | |
| 205 | -A manifest has an optional Z-card as its last line. The argument | |
| 205 | +A manifest must have a single Z-card as its last line. The argument | |
| 206 | 206 | to the Z-card is a 32-character lowercase hexadecimal MD5 hash |
| 207 | 207 | of all prior lines of the manifest up to and including the newline |
| 208 | -character that immediately precedes the "Z". The Z-card is just | |
| 208 | +character that immediately precedes the "Z". The Z-card is | |
| 209 | 209 | a sanity check to prove that the manifest is well-formed and |
| 210 | 210 | consistent. |
| 211 | 211 | |
| 212 | 212 | A sample manifest from Fossil itself can be seen |
| 213 | 213 | [/artifact/28987096ac | here]. |
| @@ -246,12 +246,11 @@ | ||
| 246 | 246 | A cluster contains one or more "M" cards followed by a single "Z" |
| 247 | 247 | line. Each M card has a single argument which is the artifact ID of |
| 248 | 248 | another artifact in the repository. The Z card work exactly like |
| 249 | 249 | the Z card of a manifest. The argument to the Z card is the |
| 250 | 250 | lower-case hexadecimal representation of the MD5 checksum of all |
| 251 | -prior cards in the cluster. Note that the Z card is required | |
| 252 | -on a cluster. | |
| 251 | +prior cards in the cluster. The Z-card is required. | |
| 253 | 252 | |
| 254 | 253 | An example cluster from Fossil can be seen |
| 255 | 254 | [/artifact/d03dbdd73a2a8 | here]. |
| 256 | 255 | |
| 257 | 256 | <a name="ctrl"></a> |
| @@ -307,11 +306,11 @@ | ||
| 307 | 306 | check-in user. The "date" tag overrides the check-in date. |
| 308 | 307 | The "branch" tag sets the name of the branch that at check-in |
| 309 | 308 | belongs to. Symbolic tags begin with the "sym-" prefix. |
| 310 | 309 | |
| 311 | 310 | The U card is the name of the user that created the control |
| 312 | -artifact. The Z card is the usual artifact checksum. | |
| 311 | +artifact. The Z card is the usual required artifact checksum. | |
| 313 | 312 | |
| 314 | 313 | An example control artifacts can be seen [/info/9d302ccda8 | here]. |
| 315 | 314 | |
| 316 | 315 | |
| 317 | 316 | <a name="wikichng"></a> |
| @@ -334,11 +333,11 @@ | ||
| 334 | 333 | |
| 335 | 334 | The D card is the date and time when the wiki page was edited. |
| 336 | 335 | The P card specifies the parent wiki pages, if any. The L card |
| 337 | 336 | gives the name of the wiki page. The U card specifies the login |
| 338 | 337 | of the user who made this edit to the wiki page. The Z card is |
| 339 | -the usual checksum over the either artifact. | |
| 338 | +the usual checksum over the either artifact and is required. | |
| 340 | 339 | |
| 341 | 340 | The W card is used to specify the text of the wiki page. The |
| 342 | 341 | argument to the W card is an integer which is the number of bytes |
| 343 | 342 | of text in the wiki page. That text follows the newline character |
| 344 | 343 | that terminates the W card. The wiki text is always followed by one |
| @@ -361,11 +360,11 @@ | ||
| 361 | 360 | <b>Z</b> <i>checksum</i> |
| 362 | 361 | </blockquote> |
| 363 | 362 | |
| 364 | 363 | The D card is the usual date and time stamp and represents the point |
| 365 | 364 | in time when the change was entered. The U card is the login of the |
| 366 | -programmer who entered this change. The Z card is the checksum over | |
| 365 | +programmer who entered this change. The Z card is the required checksum over | |
| 367 | 366 | the entire artifact. |
| 368 | 367 | |
| 369 | 368 | Every ticket has a distinct ticket-id: |
| 370 | 369 | 40-character lower-case hexadecimal number. |
| 371 | 370 | The ticket-id is given in the K-card. A ticket exists if it contains one or |
| @@ -424,10 +423,11 @@ | ||
| 424 | 423 | |
| 425 | 424 | A single U card gives the name of the user to added the attachment. |
| 426 | 425 | If an attachment is added anonymously, then the U card may be omitted. |
| 427 | 426 | |
| 428 | 427 | The Z card is the usual checksum over the rest of the attachment artifact. |
| 428 | +The Z card is required. | |
| 429 | 429 | |
| 430 | 430 | |
| 431 | 431 | <a name="event"></a> |
| 432 | 432 | <h2>7.0 Events</h2> |
| 433 | 433 | |
| @@ -485,11 +485,11 @@ | ||
| 485 | 485 | |
| 486 | 486 | A single W card provides wiki text for the document associated with the |
| 487 | 487 | event. The format of the W card is exactly the same as for a |
| 488 | 488 | [#wikichng | wiki artifact]. |
| 489 | 489 | |
| 490 | -The Z card is the usual checksum over the rest of the attachment artifact. | |
| 490 | +The Z card is the required checksum over the rest of the artifact. | |
| 491 | 491 | |
| 492 | 492 | |
| 493 | 493 | <a name="summary"></a> |
| 494 | 494 | <h2>8.0 Card Summary</h2> |
| 495 | 495 | |
| 496 | 496 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -200,14 +200,14 @@ | |
| 200 | Each manifest has a single U-card. The argument to the U-card is |
| 201 | the login of the user who created the manifest. The login name |
| 202 | is encoded using the same character escapes as is used for the |
| 203 | check-in comment argument to the C-card. |
| 204 | |
| 205 | A manifest has an optional Z-card as its last line. The argument |
| 206 | to the Z-card is a 32-character lowercase hexadecimal MD5 hash |
| 207 | of all prior lines of the manifest up to and including the newline |
| 208 | character that immediately precedes the "Z". The Z-card is just |
| 209 | a sanity check to prove that the manifest is well-formed and |
| 210 | consistent. |
| 211 | |
| 212 | A sample manifest from Fossil itself can be seen |
| 213 | [/artifact/28987096ac | here]. |
| @@ -246,12 +246,11 @@ | |
| 246 | A cluster contains one or more "M" cards followed by a single "Z" |
| 247 | line. Each M card has a single argument which is the artifact ID of |
| 248 | another artifact in the repository. The Z card work exactly like |
| 249 | the Z card of a manifest. The argument to the Z card is the |
| 250 | lower-case hexadecimal representation of the MD5 checksum of all |
| 251 | prior cards in the cluster. Note that the Z card is required |
| 252 | on a cluster. |
| 253 | |
| 254 | An example cluster from Fossil can be seen |
| 255 | [/artifact/d03dbdd73a2a8 | here]. |
| 256 | |
| 257 | <a name="ctrl"></a> |
| @@ -307,11 +306,11 @@ | |
| 307 | check-in user. The "date" tag overrides the check-in date. |
| 308 | The "branch" tag sets the name of the branch that at check-in |
| 309 | belongs to. Symbolic tags begin with the "sym-" prefix. |
| 310 | |
| 311 | The U card is the name of the user that created the control |
| 312 | artifact. The Z card is the usual artifact checksum. |
| 313 | |
| 314 | An example control artifacts can be seen [/info/9d302ccda8 | here]. |
| 315 | |
| 316 | |
| 317 | <a name="wikichng"></a> |
| @@ -334,11 +333,11 @@ | |
| 334 | |
| 335 | The D card is the date and time when the wiki page was edited. |
| 336 | The P card specifies the parent wiki pages, if any. The L card |
| 337 | gives the name of the wiki page. The U card specifies the login |
| 338 | of the user who made this edit to the wiki page. The Z card is |
| 339 | the usual checksum over the either artifact. |
| 340 | |
| 341 | The W card is used to specify the text of the wiki page. The |
| 342 | argument to the W card is an integer which is the number of bytes |
| 343 | of text in the wiki page. That text follows the newline character |
| 344 | that terminates the W card. The wiki text is always followed by one |
| @@ -361,11 +360,11 @@ | |
| 361 | <b>Z</b> <i>checksum</i> |
| 362 | </blockquote> |
| 363 | |
| 364 | The D card is the usual date and time stamp and represents the point |
| 365 | in time when the change was entered. The U card is the login of the |
| 366 | programmer who entered this change. The Z card is the checksum over |
| 367 | the entire artifact. |
| 368 | |
| 369 | Every ticket has a distinct ticket-id: |
| 370 | 40-character lower-case hexadecimal number. |
| 371 | The ticket-id is given in the K-card. A ticket exists if it contains one or |
| @@ -424,10 +423,11 @@ | |
| 424 | |
| 425 | A single U card gives the name of the user to added the attachment. |
| 426 | If an attachment is added anonymously, then the U card may be omitted. |
| 427 | |
| 428 | The Z card is the usual checksum over the rest of the attachment artifact. |
| 429 | |
| 430 | |
| 431 | <a name="event"></a> |
| 432 | <h2>7.0 Events</h2> |
| 433 | |
| @@ -485,11 +485,11 @@ | |
| 485 | |
| 486 | A single W card provides wiki text for the document associated with the |
| 487 | event. The format of the W card is exactly the same as for a |
| 488 | [#wikichng | wiki artifact]. |
| 489 | |
| 490 | The Z card is the usual checksum over the rest of the attachment artifact. |
| 491 | |
| 492 | |
| 493 | <a name="summary"></a> |
| 494 | <h2>8.0 Card Summary</h2> |
| 495 | |
| 496 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -200,14 +200,14 @@ | |
| 200 | Each manifest has a single U-card. The argument to the U-card is |
| 201 | the login of the user who created the manifest. The login name |
| 202 | is encoded using the same character escapes as is used for the |
| 203 | check-in comment argument to the C-card. |
| 204 | |
| 205 | A manifest must have a single Z-card as its last line. The argument |
| 206 | to the Z-card is a 32-character lowercase hexadecimal MD5 hash |
| 207 | of all prior lines of the manifest up to and including the newline |
| 208 | character that immediately precedes the "Z". The Z-card is |
| 209 | a sanity check to prove that the manifest is well-formed and |
| 210 | consistent. |
| 211 | |
| 212 | A sample manifest from Fossil itself can be seen |
| 213 | [/artifact/28987096ac | here]. |
| @@ -246,12 +246,11 @@ | |
| 246 | A cluster contains one or more "M" cards followed by a single "Z" |
| 247 | line. Each M card has a single argument which is the artifact ID of |
| 248 | another artifact in the repository. The Z card work exactly like |
| 249 | the Z card of a manifest. The argument to the Z card is the |
| 250 | lower-case hexadecimal representation of the MD5 checksum of all |
| 251 | prior cards in the cluster. The Z-card is required. |
| 252 | |
| 253 | An example cluster from Fossil can be seen |
| 254 | [/artifact/d03dbdd73a2a8 | here]. |
| 255 | |
| 256 | <a name="ctrl"></a> |
| @@ -307,11 +306,11 @@ | |
| 306 | check-in user. The "date" tag overrides the check-in date. |
| 307 | The "branch" tag sets the name of the branch that at check-in |
| 308 | belongs to. Symbolic tags begin with the "sym-" prefix. |
| 309 | |
| 310 | The U card is the name of the user that created the control |
| 311 | artifact. The Z card is the usual required artifact checksum. |
| 312 | |
| 313 | An example control artifacts can be seen [/info/9d302ccda8 | here]. |
| 314 | |
| 315 | |
| 316 | <a name="wikichng"></a> |
| @@ -334,11 +333,11 @@ | |
| 333 | |
| 334 | The D card is the date and time when the wiki page was edited. |
| 335 | The P card specifies the parent wiki pages, if any. The L card |
| 336 | gives the name of the wiki page. The U card specifies the login |
| 337 | of the user who made this edit to the wiki page. The Z card is |
| 338 | the usual checksum over the either artifact and is required. |
| 339 | |
| 340 | The W card is used to specify the text of the wiki page. The |
| 341 | argument to the W card is an integer which is the number of bytes |
| 342 | of text in the wiki page. That text follows the newline character |
| 343 | that terminates the W card. The wiki text is always followed by one |
| @@ -361,11 +360,11 @@ | |
| 360 | <b>Z</b> <i>checksum</i> |
| 361 | </blockquote> |
| 362 | |
| 363 | The D card is the usual date and time stamp and represents the point |
| 364 | in time when the change was entered. The U card is the login of the |
| 365 | programmer who entered this change. The Z card is the required checksum over |
| 366 | the entire artifact. |
| 367 | |
| 368 | Every ticket has a distinct ticket-id: |
| 369 | 40-character lower-case hexadecimal number. |
| 370 | The ticket-id is given in the K-card. A ticket exists if it contains one or |
| @@ -424,10 +423,11 @@ | |
| 423 | |
| 424 | A single U card gives the name of the user to added the attachment. |
| 425 | If an attachment is added anonymously, then the U card may be omitted. |
| 426 | |
| 427 | The Z card is the usual checksum over the rest of the attachment artifact. |
| 428 | The Z card is required. |
| 429 | |
| 430 | |
| 431 | <a name="event"></a> |
| 432 | <h2>7.0 Events</h2> |
| 433 | |
| @@ -485,11 +485,11 @@ | |
| 485 | |
| 486 | A single W card provides wiki text for the document associated with the |
| 487 | event. The format of the W card is exactly the same as for a |
| 488 | [#wikichng | wiki artifact]. |
| 489 | |
| 490 | The Z card is the required checksum over the rest of the artifact. |
| 491 | |
| 492 | |
| 493 | <a name="summary"></a> |
| 494 | <h2>8.0 Card Summary</h2> |
| 495 | |
| 496 |