Skip to content

Fix typo in cache docs #7144

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

Merged
randall merged 2 commits into from
Aug 27, 2020
Merged

Fix typo in cache docs #7144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd63d9
Fix typo in cache docs
GeorgeHahn Aug 27, 2020
e8783b1
fixup: use correct function definiton
GeorgeHahn Aug 27, 2020
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
4 changes: 2 additions & 2 deletions doc/developer-guide/plugins/io/cache-api.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Example
In the example below, suppose there is a cache hit and the cache returns
a vconnection that enables you to read the document from cache. To do
this, you need to prepare a buffer (``cache_bufp``) to hold the
document; meanwhile, use ``TSVConnCachedObjectSizeGet`` to find out the
document; meanwhile, use ``TSVConnCacheObjectSizeGet`` to find out the
actual size of the document (``content_length``). Then, issue
``TSVConnRead`` to read the document with the total data length required
as ``content_length``. Assume the following data:
Expand All @@ -133,7 +133,7 @@ In the ``TS_CACHE_OPEN_READ`` handler:
.. code-block:: c

cache_vconnp = (TSVConn) data;
TSVConnCachedObjectSizeGet (cache_vconnp, &content_length);
content_length = TSVConnCacheObjectSizeGet (cache_vconnp);
cache_vio = TSVConnRead (cache_vconn, contp, cache_bufp, content_length);

In the ``TS_EVENT_VCONN_READ_READY`` handler:
Expand Down
2 changes: 1 addition & 1 deletion doc/locale/ja/LC_MESSAGES/developer-guide/plugins/io/cache-api.en.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ msgid ""
"In the example below, suppose there is a cache hit and the cache returns a "
"vconnection that enables you to read the document from cache. To do this, "
"you need to prepare a buffer (``cache_bufp``) to hold the document; "
"meanwhile, use ``TSVConnCachedObjectSizeGet`` to find out the actual size "
"meanwhile, use ``TSVConnCacheObjectSizeGet`` to find out the actual size "
"of the document (``content_length``). Then, issue ``TSVConnRead`` to read "
"the document with the total data length required as ``content_length``. "
"Assume the following data:"
Expand Down