linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH RFC] Docs: mark admin-guide/iostats.rst as needing updates
Date: Fri, 18 Oct 2019 10:02:56 -0600	[thread overview]
Message-ID: <20191018100256.75bb5c60@lwn.net> (raw)

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(+)

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
-- 
2.21.0


                 reply	other threads:[~2019-10-18 16:03 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191018100256.75bb5c60@lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).