docs(web): introduce new terms corkQueue and corkIndex

Signed-off-by: Masatake YAMATO <[email protected]>
universal-ctags · Dec 28, 2022 · 9e8a785 · 9e8a785
1 parent 50e7a74
commit 9e8a785
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/docs/internal.rst b/docs/internal.rst
@@ -98,9 +98,10 @@ parser does not set ``CORK_QUEUE`` to ``useCork`` field. ``writeTagEntry`` calls
 xrefWriter, and jsonWriter.
 One of them is chosen depending on the arguments passed to ctags.
 
-If ``CORK_QUEUE`` is set to ``useCork``, the tag information goes to a queue on memory.
-The queue is flushed when ``useCork`` in unset. See "`cork API`_" for more
-details.
+If ``CORK_QUEUE`` is set to ``useCork``, the tag information goes to a
+queue (**corkQueue**) on memory, and a unique integer (**corkIndex**)
+is assigned identifying the tag information.  The queue is flushed
+when ``useCork`` in unset. See "`cork API`_" for more details.
 
 cork API
 ......................................................................