Fossil

Check-in [c3f118c5]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Continuing work on the VCCP design.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | vccp
Files: files | file ages | folders
SHA3-256:c3f118c529e94c8f64ddea131a1d8ad016ff1af6ac4c679ee1aff9d8c6b36292
User & Date: drh 2019-03-13 18:46:08
Context
2019-03-13
18:46
Continuing work on the VCCP design. Closed-Leaf check-in: c3f118c5 user: drh tags: vccp
15:34
Continuing work on the VCCP spec. This is an incremental check-in. check-in: 60794e99 user: drh tags: vccp
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to www/vccp/intro.md.

356
357
358
359
360
361
362













363
364
365
366
367
368
369
...
482
483
484
485
486
487
488

489
490
491
492
493
494
495
496
497
498
499












































that means the name is appropriate for use on the server.

To simplify the implementation of VCCP on diverse systems,
names should be sent as text.  If the names for a particular system
are binary hashes, then the NAME table should store them as
the hexadecimal representation.














#### 3.4.1 NAME Table Example 1

Suppose a client is pushing a new check-in to the server and the
check-in text is stored in the DATA.ID=1 row.  Then the request
should contain a NAME table row with NAME.NAMEID=1 (to match the
DATA table ID value) and NAME.NAMETYPE=0 (because client names
have NAMETYPE 0) and with the name of that check-in according to
................................................................................
of the file is the target of the link).  The $.file[].mode may
be blank or omitted for a normal read/write file.  If a file
is being renamed, the $.file[].oldname field may be included
to show the previous name of the file, if that information is
available.

Some version control systems allow tags and properties to be

associated with a check-in.  The $.tag element supports this
feature.  Each element of the $.tag array is a separate tag
or property.  If the $.tag[].propagate field exists and has
a value of "1", then the tag/property propagates to all
non-merge children.  If the $.tag[].delete field exists and
has a value of "1", then a propagating tag or property with 
the given name that was set by some ancestor check-in is
stopped and omitted from this check-in.  Version control
systems that do not support tags and/or properties on check-ins
or that do not support tag propagation can ignore all of these
attributes.



















































>
>
>
>
>
>
>
>
>
>
>
>
>







 







>
|










>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
...
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
that means the name is appropriate for use on the server.

To simplify the implementation of VCCP on diverse systems,
names should be sent as text.  If the names for a particular system
are binary hashes, then the NAME table should store them as
the hexadecimal representation.

The NAME table can also be used for error messages in a VCCP
reply message.  If the request contains an error associated with
a particular row in the DATA table, or with a particular NAMEID,
then an error message is added to the NAME table with NAMEID
set to the offending DATA.ID or NAMEID and NAMETYPE set to 2
and with English the error message text in NAME.NAME.  Hence,
the allowed values for NAME.NAMETYPE are:

>
| 0: | Name of the object as known to the client |
| 1: | Name of the object as known to the server |
| 2: | Error message text for the object         |

#### 3.4.1 NAME Table Example 1

Suppose a client is pushing a new check-in to the server and the
check-in text is stored in the DATA.ID=1 row.  Then the request
should contain a NAME table row with NAME.NAMEID=1 (to match the
DATA table ID value) and NAME.NAMETYPE=0 (because client names
have NAMETYPE 0) and with the name of that check-in according to
................................................................................
of the file is the target of the link).  The $.file[].mode may
be blank or omitted for a normal read/write file.  If a file
is being renamed, the $.file[].oldname field may be included
to show the previous name of the file, if that information is
available.

Some version control systems allow tags and properties to be
part of the check-in itself rather than a separate entity.  
The $.tag element supports this
feature.  Each element of the $.tag array is a separate tag
or property.  If the $.tag[].propagate field exists and has
a value of "1", then the tag/property propagates to all
non-merge children.  If the $.tag[].delete field exists and
has a value of "1", then a propagating tag or property with 
the given name that was set by some ancestor check-in is
stopped and omitted from this check-in.  Version control
systems that do not support tags and/or properties on check-ins
or that do not support tag propagation can ignore all of these
attributes.

### 3.6 Tag JSON Format

A new tag is created using the following JSON syntax:

>
    {
      "time": DATETIME,    -- Time when the tag was created
      "name": TEXT,        -- Name of the tag
      "from": INT,         -- Check-in being tagged
      "comment": TEXT,     -- Message associated with the tag
      "mimetype": TEXT,    -- Mimetype of the message
      "value": TEXT,       -- Value of the tag if it is really a property
      "delete": 1,         -- Stop propagaging this tag
      "propagate": 1,      -- Propagate this tag to direct children
      "tagger": {          -- Person who created this tag
        "name": TEXT,           -- Name or handle
        "email": TEXT,          -- Email address
        "time": DATETIME        -- Override for $.time
      }
    }

### 3.7 Message Description JSON Format

>
    {
      "version": INT,               -- protocol version number
      "features": [TEXT],            -- supported optional features
      "client_vcs": TEXT,
      "server_vcs": TEXT,
      "credentials": {
         "username": TEXT,
         "password": TEXT,
      }
      "pull": [{
         "branch": TEXT,
         "decendents_of": TEXT,
         "after": DATETIME
      }],
      "max_size_hint": INT,
      "done": 1,
      "more_available": 1,
      "continue_with": JSON,
    }