]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rbd/rbd-persistent-write-back-cache: update "Cache Status" section
authorIlya Dryomov <idryomov@gmail.com>
Thu, 6 May 2021 09:20:23 +0000 (11:20 +0200)
committerIlya Dryomov <idryomov@gmail.com>
Tue, 11 May 2021 11:56:39 +0000 (13:56 +0200)
Amend the example output and drop the word "transient" -- currently it
is the exact opposite, as the status is updated only when the cache is
opened and closed.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
(cherry picked from commit a227abfb3653268324b5379ede2c1f171929dd15)

doc/rbd/rbd-persistent-write-back-cache.rst

index e8ecf4a810ec3dddfda42f9c03c9890708b13476..2ac146d5f2b5bdd0ec798133b59742f3a3b85d8f 100644 (file)
@@ -70,21 +70,21 @@ Cache Status
 ------------
 
 The persistent write-back cache is enabled when the exclusive lock is acquired,
-and it is closed when the exclusive lock is released. To check the transient
-cache status, users may use the command ``rbd status``.  ::
+and it is closed when the exclusive lock is released. To check the cache status,
+users may use the command ``rbd status``.  ::
 
         rbd status {pool-name}/{image-name}
 
 The status of the cache is shown, including present, clean, cache size and the
-position.
+location. Currently the status is updated only at the time the cache is opened
+and closed and therefore may appear to be out of date (e.g. show that the cache
+is clean when it is actually dirty).
 
 For example::
 
         $ rbd status rbd/foo
         Watchers: none
-        image cache state:
-        clean: false  size: 1 GiB  host: sceph9  path: /tmp
-
+        Image cache state: {"present":"true","empty":"false","clean":"true","cache_type":"ssd","pwl_host":"sceph9","pwl_path":"/tmp/rbd-pwl.rbd.abcdef123456.pool","pwl_size":1073741824}
 
 Discard Cache
 -------------