Skip to content

Commit 20480d8

Browse files
committed
Add notes to LVS docs
1 parent 44ef2ca commit 20480d8

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

docs/src/lvs/binary-format.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This page describes version ``0x00011000``.
5353
FnId
5454
*UserFnArg
5555
FnId = USER-FN-ID-TYPE TLV-LENGTH "$" CNAME
56-
UserFnArg = USER-FN-ARG-TYPE TLV-LENGTH (Value / Tag)
56+
UserFnArg = FN-ARGS-TYPE TLV-LENGTH (Value / Tag)
5757
5858
TagSymbol = TAG-SYMBOL-TYPE TLV-LENGTH
5959
Tag

docs/src/lvs/demonstration.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ Generating tree
6969
:align: center
7070
:width: 100%
7171

72-
Each node is a name prefix, and edge becoming the condition to
72+
Each node is a name prefix, and edge becoming the condition to the nodes.
73+
74+
.. note::
75+
In the figure we omitted ununsed branch ``"KEY"/_/_/_`` from the root, but the compiler will generate it.
76+
So, the total number of nodes is 26.
7377

7478
Fixing signing constraints
7579
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -87,16 +91,16 @@ and model the name pattern tree into a TLV encodable model.
8791

8892
Checker
8993
~~~~~~~~
90-
In order to check a name ``/lvs-test/article/alice/post1/v=2`` can be signed by
91-
name ``/lvs-test/author/alice/KEY/%BDA%D6%DE%EA%09%3C%E0/admin/v=1647807153833``,
92-
Checker first matches ``/lvs-test/article/alice/post1/v=2`` against the name
94+
In order to check a name ``/lvs-test/article/alice/post1/v=2`` can be signed by
95+
name ``/lvs-test/author/alice/KEY/%BDA%D6%DE%EA%09%3C%E0/admin/v=1647807153833``,
96+
Checker first matches ``/lvs-test/article/alice/post1/v=2`` against the name
9397
pattern tree, which gives the uppermost branch of the pattern tree.
9498

95-
Along the matching, checker fills the symbols with ``author = "alice"``
99+
Along the matching, checker fills the symbols with ``author = "alice"``
96100
and ``post = "post1"``.
97101
The end of this branch indicates the node identifier (e.g., ``x``) for this branch.
98102

99-
Then the checker matches the ``/lvs-test/author/alice/KEY/...``
103+
Then the checker matches the ``/lvs-test/author/alice/KEY/...``
100104
against the name pattern tree, which gives the second branch from the top.
101105
When matching along this branch, checker uses "alice" for ``1``'s value.
102106
The end of this branch has the same node identifier ``x``, thereby the checking succeeds.

0 commit comments

Comments
 (0)