docs: admin-guide/blockdev: Remove digraph of node-states
authorAkira Yokosawa <akiyks@gmail.com>
Fri, 26 Nov 2021 04:11:17 +0000 (13:11 +0900)
committerJonathan Corbet <corbet@lwn.net>
Mon, 29 Nov 2021 21:39:43 +0000 (14:39 -0700)
While node-states-8.dot has two digraphs, the dot(1) command can
not properly handle multiple graphs in a DOT file and the
kernel-doc page at

    https://www.kernel.org/doc/html/latest/admin-guide/blockdev/drbd/figures.html

fails to render the graphs.

It turned out that the digraph of node_states can be removed.

Quote from Joel's reflection:

    On reflection, the digraph node_states can be removed entirely.
    It is too basic to contain any useful information. In addition
    it references "ioctl_set_state". The ioctl configuration
    interface for DRBD has long been removed. In fact, it was never
    in the upstream version of DRBD.

Remove node_states and rename the DOT file peer_states-8.dot.

Suggested-by: Joel Colledge <joel.colledge@linbit.com>
Acked-by: Joel Colledge <joel.colledge@linbit.com>
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Philipp Reisner <philipp.reisner@linbit.com>
Cc: Lars Ellenberg <lars.ellenberg@linbit.com>
Link: https://lore.kernel.org/r/7df04f45-8746-e666-1a9d-a998f1ab1f91@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/admin-guide/blockdev/drbd/figures.rst
Documentation/admin-guide/blockdev/drbd/node-states-8.dot [deleted file]
Documentation/admin-guide/blockdev/drbd/peer-states-8.dot [new file with mode: 0644]

index bd9a4901fe46d7856d1a1cee33ccd78738cad29e..9f73253ea35324231f2e90f1eab75e438ba63654 100644 (file)
@@ -25,6 +25,6 @@ Sub graphs of DRBD's state transitions
     :alt:   disk-states-8.dot
     :align: center
 
-.. kernel-figure:: node-states-8.dot
-    :alt:   node-states-8.dot
+.. kernel-figure:: peer-states-8.dot
+    :alt:   peer-states-8.dot
     :align: center
diff --git a/Documentation/admin-guide/blockdev/drbd/node-states-8.dot b/Documentation/admin-guide/blockdev/drbd/node-states-8.dot
deleted file mode 100644 (file)
index bfa54e1..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-digraph node_states {
-       Secondary -> Primary           [ label = "ioctl_set_state()" ]
-       Primary   -> Secondary         [ label = "ioctl_set_state()" ]
-}
-
-digraph peer_states {
-       Secondary -> Primary           [ label = "recv state packet" ]
-       Primary   -> Secondary         [ label = "recv state packet" ]
-       Primary   -> Unknown           [ label = "connection lost" ]
-       Secondary  -> Unknown          [ label = "connection lost" ]
-       Unknown   -> Primary           [ label = "connected" ]
-       Unknown   -> Secondary         [ label = "connected" ]
-}
diff --git a/Documentation/admin-guide/blockdev/drbd/peer-states-8.dot b/Documentation/admin-guide/blockdev/drbd/peer-states-8.dot
new file mode 100644 (file)
index 0000000..6dc3954
--- /dev/null
@@ -0,0 +1,8 @@
+digraph peer_states {
+       Secondary -> Primary           [ label = "recv state packet" ]
+       Primary   -> Secondary         [ label = "recv state packet" ]
+       Primary   -> Unknown           [ label = "connection lost" ]
+       Secondary  -> Unknown          [ label = "connection lost" ]
+       Unknown   -> Primary           [ label = "connected" ]
+       Unknown   -> Secondary         [ label = "connected" ]
+}