From: Sergey Matveev <stargrave@stargrave.org>
Date: Thu, 10 Apr 2025 10:19:43 +0000 (+0300)
Subject: Repaired CKEKS documentation
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=1e406ffd21faa4e14872aae4c93078b632ca9e8515273046c5697ebdd2e3cd5e;p=keks.git

Repaired CKEKS documentation
---

diff --git a/c/doc/cm.texi b/c/doc/cm.texi
new file mode 100644
index 0000000..fb51a56
--- /dev/null
+++ b/c/doc/cm.texi
@@ -0,0 +1,19 @@
+@node CM
+@cindex CM
+@unnumbered CM
+
+@file{lib/cm} contains CM-related code. It is not directly related to
+the KEKS codec, so it is placed isolated nearby. Currently there are
+functions to deal with public keys verification:
+
+@anchor{KEKSCMPub}
+@DOCSTRING KEKSCMPub@
+
+@DOCSTRING KEKSCMPubParse@
+
+@DOCSTRING KEKSCMPubVerify@
+
+@DOCSTRING KEKSCMPubVerifyOpts@
+
+@anchor{KEKSCMPubSigVerifier}
+@DOCSTRING KEKSCMPubSigVerifier@
diff --git a/c/doc/cmd.texi b/c/doc/cmd.texi
index 4f8bcda..e1baec8 100644
--- a/c/doc/cmd.texi
+++ b/c/doc/cmd.texi
@@ -10,15 +10,15 @@ Example program that forms the same test vector as
 
 @pindex cmd/deatomiser
 @item cmd/deatomiser
-Example program that decodes the provided file with iterated
-functions, that uses pretty printer as a callback.
+Decodes the provided file with iterated functions, that uses pretty
+printer as a callback.
 
 @pindex cmd/pp
 @item cmd/pp
-Example program that decodes the provided file into @ref{Items, items}
-and pretty prints it. It respects @env{$NO_COLOR} environment variable.
-If @env{$DO_ENCODE} is specified, then it encodes the decoded items into
-memory again and compares if it has the same representation.
+Decodes the provided file into @ref{Items, items} and pretty prints it.
+It respects @env{$NO_COLOR} environment variable. If @env{$DO_ENCODE} is
+specified, then it encodes the decoded items into memory again and
+compares if it has the same representation.
 
 @pindex cmd/pub-verify
 @item cmd/pub-verify
@@ -28,7 +28,7 @@ Ed25519-BLAKE2b cryptographic handlers for signature verification.
 
 @pindex cmd/schema-validate
 @item cmd/schema-validate
-Example program that accepts KEKS-encoded schemas, KEKS-encoded data and
-schema name to verify against.
+Accepts KEKS-encoded schemas, KEKS-encoded data and schema name to verify
+against.
 
 @end table
diff --git a/c/doc/docstringer.log.do b/c/doc/docstringer.log.do
index ed1b0e0..64e1ec1 100644
--- a/c/doc/docstringer.log.do
+++ b/c/doc/docstringer.log.do
@@ -1,3 +1,3 @@
-redo-ifchange docstringer.pl *.texi ../lib/*.h ../lib/pki/*.h
+redo-ifchange docstringer.pl *.texi ../lib/*.h ../lib/cm/*.h
 rm -rf build
-./docstringer.pl -v build ../lib:../lib/pki .
+./docstringer.pl -v build ../lib:../lib/cm .
diff --git a/c/doc/index.texi b/c/doc/index.texi
index 1f6cbf7..b799450 100644
--- a/c/doc/index.texi
+++ b/c/doc/index.texi
@@ -32,7 +32,8 @@ licenced under @url{https://www.gnu.org/licenses/lgpl-3.0.html, GNU LGPLv3}.
 @include atom.texi
 @include tai64.texi
 @include items.texi
-@include pki.texi
+@include schema.texi
+@include cm.texi
 
 @node Indices
 @unnumbered Indices
diff --git a/c/doc/install.texi b/c/doc/install.texi
index cb7861a..6801715 100644
--- a/c/doc/install.texi
+++ b/c/doc/install.texi
@@ -10,3 +10,18 @@ is ordinary C project.
 
 Whole configuration is in @file{conf/} directory, where you can override
 default command invocations and paths.
+
+@example
+$ cat >>conf/cflags <<EOF
+-Weverything
+-O0
+-g
+EOF
+$ echo /somewhere/keks >conf/prefix
+
+$ redo lib/install lib/cm/install
+
+$ cd cmd/pp
+$ redo
+$ ./pp ../../lib/cm/pub.schema.keks
+@end example
diff --git a/c/doc/items.texi b/c/doc/items.texi
index 93fce40..19b3a0c 100644
--- a/c/doc/items.texi
+++ b/c/doc/items.texi
@@ -18,7 +18,4 @@ There is ability to recursively decode the whole structures.
 @DOCSTRING KEKSItemsGetByKeyLen@
 @anchor{KEKSItemsGetByKey}
 @DOCSTRING KEKSItemsGetByKey@
-@DOCSTRING KEKSItemsGetByKeyAndType@
 @DOCSTRING KEKSStrEqual@
-@DOCSTRING KEKSListHasOnlyType@
-@DOCSTRING KEKSMapHasOnlyType@
diff --git a/c/doc/pki.texi b/c/doc/pki.texi
deleted file mode 100644
index db36e6a..0000000
--- a/c/doc/pki.texi
+++ /dev/null
@@ -1,19 +0,0 @@
-@node PKI
-@cindex PKI
-@unnumbered PKI
-
-@file{lib/pki} contains PKI-related code. It is not directly related to
-the KEKS codec, so it is placed isolated nearby. Currently there are
-functions to deal with certificate verification:
-
-@anchor{KEKSCer}
-@DOCSTRING KEKSCer@
-
-@DOCSTRING KEKSCerParse@
-
-@DOCSTRING KEKSCerVerify@
-
-@DOCSTRING KEKSCerVerifyOpts@
-
-@anchor{KEKSCerSigVerifier}
-@DOCSTRING KEKSCerSigVerifier@
diff --git a/c/doc/schema.texi b/c/doc/schema.texi
new file mode 100644
index 0000000..7950d98
--- /dev/null
+++ b/c/doc/schema.texi
@@ -0,0 +1,12 @@
+@node Schema
+@cindex schema
+@unnumbered Schema
+
+@anchor{KEKSSchemaErrType}
+@DOCSTRING KEKSSchemaErrType@
+
+@anchor{KEKSSchemaErr}
+@DOCSTRING KEKSSchemaErr@
+
+@anchor{KEKSSchemaValidate}
+@DOCSTRING KEKSSchemaValidate@