Skip to content

docs(web): update optscript.rst (in progress) #2997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(web): update optscript.rst (in progress) #2997

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e8a785
docs(web): introduce new terms corkQueue and corkIndex
masatake May 3, 2021
3b9df16
docs(web): update optscript.rst (in progress)
masatake May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/internal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description is wrong.

The entries are flushed when all parsing tasks including running guest parsers are finished. See "`cork API`_" for more details.

when ``useCork`` in unset. See "`cork API`_" for more details.

cork API
......................................................................
Expand Down