[PATCH v2] docs: admin-guide/blockdev: Remove digraph of node-states

[PATCH v2] docs: admin-guide/blockdev: Remove digraph of node-states

[Akira Yokosawa]

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>
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Philipp Reisner <philipp.reisner@linbit.com>
Cc: Lars Ellenberg <lars.ellenberg@linbit.com>
---
Changes in v1 [1] -> v2

 - As suggested by Joel, remove the digraph of node_states.
 - Rename the DOT file peers-states-8.dot.
 - Update the change log and the patch title.
 - Add Joel's Suggested-by.

[1]: https://lkml.kernel.org/r/3cbff170-582b-b6cf-0988-e0d0c9b47505@gmail.com

Joel, are you OK with this change going through the -doc tree?

        Thanks, Akira
--
 Documentation/admin-guide/blockdev/drbd/figures.rst          | 4 ++--
 .../blockdev/drbd/{node-states-8.dot => peer-states-8.dot}   | 5 -----
 2 files changed, 2 insertions(+), 7 deletions(-)
 rename Documentation/admin-guide/blockdev/drbd/{node-states-8.dot => peer-states-8.dot} (71%)

diff --git a/Documentation/admin-guide/blockdev/drbd/figures.rst b/Documentation/admin-guide/blockdev/drbd/figures.rst
index bd9a4901fe46..9f73253ea353 100644
--- a/Documentation/admin-guide/blockdev/drbd/figures.rst
+++ b/Documentation/admin-guide/blockdev/drbd/figures.rst
@@ -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/peer-states-8.dot
similarity index 71%
rename from Documentation/admin-guide/blockdev/drbd/node-states-8.dot
rename to Documentation/admin-guide/blockdev/drbd/peer-states-8.dot
index bfa54e1f8016..6dc3954954d6 100644
--- a/Documentation/admin-guide/blockdev/drbd/node-states-8.dot
+++ b/Documentation/admin-guide/blockdev/drbd/peer-states-8.dot
@@ -1,8 +1,3 @@
-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" ]

base-commit: b96ff02ab2be1791248237b1bf318aaf62e8b701
-- 
2.17.1

Re: [PATCH v2] docs: admin-guide/blockdev: Remove digraph of node-states

[Joel Colledge]

> Joel, are you OK with this change going through the -doc tree?

Yes. This has my ack. Thanks!

Joel

Re: [PATCH v2] docs: admin-guide/blockdev: Remove digraph of node-states

[Jonathan Corbet]

Akira Yokosawa <akiyks@gmail.com> writes:

> 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>
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Cc: Philipp Reisner <philipp.reisner@linbit.com>
> Cc: Lars Ellenberg <lars.ellenberg@linbit.com>

Applied, thanks.

jon