internals: document CBOR utilization
I spoke with some people at Mozilla about CBOR and they advised me
that we should be careful about the subset of CBOR we use in order
to mitigate security, performance, and compatibility concerns.
This commit establishes a document that attempts to formalize our
use of CBOR.
Its main limitations are on what types are allowed. It explicitly
enumerates which types are supported. Notable missing features
include:
* Indefinite-length arrays and maps
* Text strings (bytes all the way)
* Floats
* Date/time types
* Big integers
* Use of indefinite-length byte strings for map keys, values in
containers.
If we have a need for any of these, we can have a discussion about
them when the time comes.
Differential Revision: https://phab.mercurial-scm.org/D4412
#require no-symlink
# The following script was used to create the bundle:
#
# hg init symlinks
# cd symlinks
# echo a > a
# mkdir d
# echo b > d/b
# ln -s a a.lnk
# ln -s d/b d/b.lnk
# hg ci -Am t
# hg bundle --base null ../test-no-symlinks.hg
Extract a symlink on a platform not supporting them
$ hg init t
$ cd t
$ hg pull -q "$TESTDIR/bundles/test-no-symlinks.hg"
$ hg update
4 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ cat a.lnk && echo
a
$ cat d/b.lnk && echo
d/b
Copy a symlink and move another
$ hg copy a.lnk d/a2.lnk
$ hg mv d/b.lnk b2.lnk
$ hg ci -Am copy
$ cat d/a2.lnk && echo
a
$ cat b2.lnk && echo
d/b
Bundle and extract again
$ hg bundle --base null ../symlinks.hg
2 changesets found
$ cd ..
$ hg init t2
$ cd t2
$ hg pull ../symlinks.hg
pulling from ../symlinks.hg
requesting all changes
adding changesets
adding manifests
adding file changes
added 2 changesets with 6 changes to 6 files
new changesets d326ae2d01ee:71d85cf3ba90
(run 'hg update' to get a working copy)
$ hg update
5 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ cat a.lnk && echo
a
$ cat d/a2.lnk && echo
a
$ cat b2.lnk && echo
d/b