]> Cypherpunks repositories - keks.git/commitdiff
Trivial small conveniences
authorSergey Matveev <stargrave@stargrave.org>
Mon, 16 Jun 2025 13:24:49 +0000 (16:24 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Mon, 16 Jun 2025 14:47:17 +0000 (17:47 +0300)
spec/ComparisonWithOtherCodecs [deleted file]
spec/INSTALL
spec/codecs [new file with mode: 0644]
spec/comparison [new file with mode: 0644]
spec/index
spec/mk-html

diff --git a/spec/ComparisonWithOtherCodecs b/spec/ComparisonWithOtherCodecs
deleted file mode 100644 (file)
index 07a264a..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-Are not there any satisfiable codecs?
-
-=> https://en.wikipedia.org/wiki/Distinguished_Encoding_Rules#DER_encoding DER\r
-=> https://en.wikipedia.org/wiki/Distinguished_Encoding_Rules#CER_encoding CER\r
-=> https://datatracker.ietf.org/doc/html/rfc1014 XDR\r
-=> https://www.JSON.org/json-en.html JSON\r
-=> https://bsonspec.org/ BSON\r
-=> https://msgpack.org/ MessagePack\r
-=> https://datatracker.ietf.org/doc/html/rfc8949 CBOR\r
-=> https://datatracker.ietf.org/doc/html/draft-mcnally-deterministic-cbor-11 dCBOR\r
-=> http://cr.yp.to/proto/netstrings.txt Netstrings\r
-=> https://wiki.theory.org/BitTorrentSpecification#Bencoding Bencode\r
-=> https://en.wikipedia.org/wiki/Canonical_S-expressions Canonical S-expression\r
-
-            | Schemaless | Simple | Deterministic | Streamable | Compact
-ASN.1 DER   | N          | N      | Y             | N          | N
-ASN.1 CER   | N          | N      | Y             | Y          | N
-XDR         | N          | Y      | N             | N          | N
-JSON        | Y          | N      | N             | Y          | N
-BSON        | Y          | Y      | N             | N          | N
-MessagePack | Y          | Y      | N             | N          | Y
-CBOR        | Y          | N      | N             | Y          | Y
-dCBOR       | Y          | N      | Y             | N          | Y
-Netstrings  | Y          | Y      | Y             | N          | ~
-Bencode     | Y          | Y      | Y             | Y          | ~
-CSExp       | Y          | Y      | Y             | Y          | ~
-KEKS        | Y          | Y      | Y             | Y          | Y
-
-            | BigStr | BinStr | UTF8Str | Int | BigInt | List | Struct | Time
-ASN.1 DER   | Y      | Y      | Y       | Y   | Y      | Y    | Y      | Y
-ASN.1 CER   | Y      | Y      | Y       | Y   | Y      | Y    | Y      | Y
-XDR         | N      | Y      | Y       | Y   | N      | Y    | Y      | N
-JSON        | Y      | N      | Y       | Y   | Y      | Y    | Y      | N
-BSON        | N      | Y      | Y       | Y   | N      | Y    | Y      | Y
-MessagePack | N      | Y      | Y       | Y   | N      | Y    | Y      | N
-CBOR        | Y      | Y      | Y       | Y   | N      | Y    | Y      | N
-dCBOR       | Y      | Y      | Y       | Y   | N      | Y    | Y      | N
-Netstrings  | Y      | Y      | N       | N   | N      | N    | N      | N
-Bencode     | Y      | Y      | N       | Y   | Y      | Y    | Y      | N
-CSExp       | Y      | Y      | N       | N   | N      | Y    | N      | N
-KEKS        | Y      | Y      | Y       | Y   | Y      | Y    | Y      | Y
-
-Note about CBOR:
-
-* Hardly you will find wide range of CBOR libraries supporting strict
-  validation of deterministically encoded CBOR structures.
-* Tagged string/integer can not be taken as a viable first-class
-  bigint/datetime data support, because many decoders do not support
-  tags and won't be able to interpret/validate them.
-* Non-string map keys very complicates representation process for
-  dynamically types languages.
index 7c25dcdcd310cf8c1a94288a09a7abb530a667eb4b0b2bebaa95b38d3c886bd5..6098c7eb100286df936c51eb89279ad574b79c0cbebde0c028b059f4e70e6a52 100644 (file)
@@ -1,5 +1,5 @@
-Currently there are draft versions of the codec written on C, Go,
-Python and Tcl.
+Currently there are draft versions of the codec written on
+C99, Go, Python3 and Tcl.
 
 You can obtain development source code with:
     git clone git://git.cypherpunks.su/keks.git
diff --git a/spec/codecs b/spec/codecs
new file mode 100644 (file)
index 0000000..2feca8c
--- /dev/null
@@ -0,0 +1,10 @@
+=> https://en.wikipedia.org/wiki/Distinguished_Encoding_Rules#DER_encoding DER\r
+=> https://en.wikipedia.org/wiki/Distinguished_Encoding_Rules#CER_encoding CER\r
+=> https://www.JSON.org/json-en.html JSON\r
+=> https://bsonspec.org/ BSON\r
+=> https://msgpack.org/ MessagePack\r
+=> https://datatracker.ietf.org/doc/html/rfc8949 CBOR\r
+=> https://datatracker.ietf.org/doc/html/draft-mcnally-deterministic-cbor-11 dCBOR\r
+=> http://cr.yp.to/proto/netstrings.txt Netstrings\r
+=> https://wiki.theory.org/BitTorrentSpecification#Bencoding Bencode\r
+=> https://en.wikipedia.org/wiki/Canonical_S-expressions Canonical S-expressions\r
diff --git a/spec/comparison b/spec/comparison
new file mode 100644 (file)
index 0000000..2c4295d
--- /dev/null
@@ -0,0 +1,40 @@
+Are not there any satisfiable [codecs]?
+
+            | simple | deterministic | streamable | compact
+------------+--------+---------------+------------+--------
+ASN.1 DER   | N      | Y             | N          | N
+ASN.1 CER   | N      | Y             | Y          | N
+JSON        | N      | N             | Y          | N
+BSON        | Y      | N             | N          | N
+MessagePack | Y      | N             | N          | Y
+CBOR        | N      | N             | Y          | Y
+dCBOR       | N      | Y             | N          | Y
+Netstrings  | Y      | Y             | N          | ~
+Bencode     | Y      | Y             | Y          | ~
+CSExp       | Y      | Y             | Y          | ~
+KEKS        | Y      | Y             | Y          | Y
+
+            | big | bin | UTF |     | big |      |     |
+            | str | str | str | int | int | list | map | time
+------------+-----+-----+-----+-----+-----+------+-----+-----
+ASN.1 DER   | Y   | Y   | Y   | Y   | Y   | Y    | Y   | Y
+ASN.1 CER   | Y   | Y   | Y   | Y   | Y   | Y    | Y   | Y
+JSON        | Y   | N   | Y   | Y   | Y   | Y    | Y   | N
+BSON        | N   | Y   | Y   | Y   | N   | Y    | Y   | Y
+MessagePack | N   | Y   | Y   | Y   | N   | Y    | Y   | N
+CBOR        | Y   | Y   | Y   | Y   | N   | Y    | Y   | N
+dCBOR       | Y   | Y   | Y   | Y   | N   | Y    | Y   | N
+Netstrings  | Y   | Y   | N   | N   | N   | N    | N   | N
+Bencode     | Y   | Y   | N   | Y   | Y   | Y    | Y   | N
+CSExp       | Y   | Y   | N   | N   | N   | Y    | N   | N
+KEKS        | Y   | Y   | Y   | Y   | Y   | Y    | Y   | Y
+
+Note about CBOR:
+
+* Hardly you will find wide range of CBOR libraries supporting strict
+  validation of deterministically encoded CBOR structures.
+* Tagged string/integer can not be taken as a viable first-class
+  bigint/datetime data support, because many decoders do not support
+  tags and won't be able to interpret/validate them.
+* Non-string map keys very complicates representation process for
+  dynamically types languages.
index 985681e7d06f361882d394525116747cf6145935d3a78566e167fe4ca1b608de..d062f94d3cea6f3a3afac8314d384383ce1c3c7094370300a9185f0e8b3fb417 100644 (file)
@@ -27,7 +27,7 @@ requirements below.
 * It *should* differentiate binary and human-readable strings.
 * It *would* be nice to have human-editable intermediate representation.
 
-<<[ComparisonWithOtherCodecs]\r
+<<[comparison]\r
 
   [INSTALL]
 [encoding/]
index e0498e9f996a931aeef5344be2946f96b52d59a0dccea27bb9a88d5e56fe33d5..6b8bfbdf61712eafecad02e6f3f2985b88119a5d0c8c5a56f03250aa88a3c64d 100755 (executable)
@@ -2,7 +2,7 @@
 # git://git.stargrave.org/swg.git is used
 
 html=spec.html
-SWG_DO_BACKS=0 swg htmls $html
+SWG_DO_BACKS=0 SWG_DO_SRC=0 swg htmls $html
 perl -i -npe 's#^<title>.*$#<title>KEKS</title>#' $html/index.html
 find $html -type d -exec chmod 755 {} +
 find $html -type f -exec chmod 644 {} +