linux-raid.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mateusz Kusiak <mateusz.kusiak@intel.com>
To: linux-raid@vger.kernel.org
Cc: jes@trained-monkey.org, mariusz.tkaczyk@linux.intel.com
Subject: [PATCH 8/8] Add understanding output section in man
Date: Tue, 16 Jan 2024 12:24:34 +0100	[thread overview]
Message-ID: <20240116112434.30705-9-mateusz.kusiak@intel.com> (raw)
In-Reply-To: <20240116112434.30705-1-mateusz.kusiak@intel.com>

Add new section in man for explaining mdadm outputs.
Describe checkpoint entry.

Signed-off-by: Mateusz Kusiak <mateusz.kusiak@intel.com>
---
 mdadm.8.in | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/mdadm.8.in b/mdadm.8.in
index b7159509f74d..7c8959be8810 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -3197,7 +3197,7 @@ environment.  This can be useful for testing or for disaster
 recovery.  You should be aware that interoperability may be
 compromised by setting this value.
 
-These change can also be suppressed by adding 
+These change can also be suppressed by adding
 .B mdadm.imsm.test=1
 to the kernel command line. This makes it easy to test IMSM
 code in a virtual machine that doesn't have IMSM virtual hardware.
@@ -3464,6 +3464,25 @@ is any string.  These names are supported by
 since version 3.3 provided they are enabled in
 .IR mdadm.conf .
 
+.SH UNDERSTANDING OUTPUT
+
+.TP
+EXAMINE
+
+.TP
+.B checkpoint
+Checkpoint value is reported when array is performing some action including
+resync, recovery or reshape. Checkpoints allow resuming action from certain
+point if it was interrupted.
+
+Checkpoint is reported as combination of two values: current migration unit
+and number of blocks per unit. By multiplying those values and dividing by
+array size checkpoint progress percentage can be obtained in relation to
+current progress reported in /proc/mdstat. Checkpoint is also related to (and
+sometimes based on) sysfs entry sync_completed but depending on action units
+may differ. Even if units are the same, it should not be expected that
+checkpoint and sync_completed will be exact match nor updated simultaneously.
+
 .SH NOTE
 .I mdadm
 was previously known as
-- 
2.35.3


  parent reply	other threads:[~2024-01-16 11:27 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-16 11:24 [PATCH 0/8] Fix checkpointing Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 1/8] Remove hardcoded checkpoint interval checking Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 2/8] monitor: refactor checkpoint update Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 3/8] Super-intel: Fix first checkpoint restart Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 4/8] Define sysfs max buffer size Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 5/8] Replace "none" with macro Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 6/8] super-intel: Remove inaccessible code Mateusz Kusiak
2024-01-16 11:24 ` [PATCH 7/8] Grow: Move update_tail assign to Grow_reshape() Mateusz Kusiak
2024-01-16 11:24 ` Mateusz Kusiak [this message]
2024-01-17  8:02 ` [PATCH 0/8] Fix checkpointing Mariusz Tkaczyk

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=20240116112434.30705-9-mateusz.kusiak@intel.com \
    --to=mateusz.kusiak@intel.com \
    --cc=jes@trained-monkey.org \
    --cc=linux-raid@vger.kernel.org \
    --cc=mariusz.tkaczyk@linux.intel.com \
    /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).