docs: filesystems: caching/backend-api.rst: fix an object withdrawn API
authorYue Hu <huyue2@coolpad.com>
Thu, 7 Apr 2022 11:02:39 +0000 (19:02 +0800)
committerDavid Howells <dhowells@redhat.com>
Fri, 8 Apr 2022 22:54:37 +0000 (23:54 +0100)
There's no fscache_are_objects_withdrawn() helper at all to test if
cookie withdrawal is completed currently. The cache backend is using
fscache_wait_for_objects() to wait all objects to be withdrawn.

Signed-off-by: Yue Hu <huyue2@coolpad.com>
Signed-off-by: David Howells <dhowells@redhat.com>
cc: linux-cachefs@redhat.com
Link: https://listman.redhat.com/archives/linux-cachefs/2022-April/006705.html
Documentation/filesystems/caching/backend-api.rst

index d7b2df5..d7507be 100644 (file)
@@ -110,9 +110,9 @@ to withdraw them, calling::
 
 on the cookie that each object belongs to.  This schedules the specified cookie
 for withdrawal.  This gets offloaded to a workqueue.  The cache backend can
-test for completion by calling::
+wait for completion by calling::
 
-       bool fscache_are_objects_withdrawn(struct fscache_cookie *cache);
+       void fscache_wait_for_objects(struct fscache_cache *cache);
 
 Once all the cookies are withdrawn, a cache backend can withdraw all the
 volumes, calling::