[RFC] Docs: mark admin-guide/iostats.rst as needing updates
diff mbox series

Message ID 20191018100256.75bb5c60@lwn.net
State New
Headers show
Series
  • [RFC] Docs: mark admin-guide/iostats.rst as needing updates
Related show

Commit Message

Jonathan Corbet Oct. 18, 2019, 4:02 p.m. UTC
This file tells us all about how 2.4 reported I/O statistics, which is less
than fully useful.  Put a note at the top advising of this fact and
requesting some kind soul to bring things up to date.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---

I'm thinking about beginning to sprinkle these around Documentation/ in
the hope that they inspire helpful people to improve the situation.  It
works (I think?) for wikipedia, maybe we should give it a try...

 Documentation/admin-guide/iostats.rst | 5 +++++
 1 file changed, 5 insertions(+)

Patch
diff mbox series

diff --git a/Documentation/admin-guide/iostats.rst b/Documentation/admin-guide/iostats.rst
index 5d63b18bd6d1..2d1b1c15fd91 100644
--- a/Documentation/admin-guide/iostats.rst
+++ b/Documentation/admin-guide/iostats.rst
@@ -2,6 +2,11 @@ 
 I/O statistics fields
 =====================
 
+.. note::
+
+   This document contains a great deal of outdated information; please
+   consider helping out by updating it to match current reality.
+
 Since 2.4.20 (and some versions before, with patches), and 2.5.45,
 more extensive disk statistics have been introduced to help measure disk
 activity. Tools such as ``sar`` and ``iostat`` typically interpret these and do