doc: update RWBS descriptions
authorStefan Hajnoczi <stefanha@redhat.com>
Tue, 28 Jan 2025 19:05:44 +0000 (14:05 -0500)
committerJens Axboe <axboe@kernel.dk>
Thu, 30 Jan 2025 16:54:59 +0000 (09:54 -0700)
New RWBS flags have been added. Document them.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Link: https://lore.kernel.org/r/20250128190544.113575-1-stefanha@redhat.com
Signed-off-by: Jens Axboe <axboe@kernel.dk>
doc/blkparse.1
doc/blktrace.tex

index 4c26baffc56c35de343b1b48ca77389ff2d3bb1a..93aa44911142d703d3ab00983225f8aa564639c0 100644 (file)
@@ -435,10 +435,41 @@ Split
 
 .SH "RWBS DESCRIPTION"
 
-This is a small string containing at least one character ('R' for read, 'W'
-for write, or 'D' for block discard operation), and optionally either
-a 'B' (for barrier operations) or 'S' (for synchronous operations).
+This is a small string containing characters in the following order:
 
+.IP F
+Flush
+
+.IP R
+Read
+
+.IP W
+Write
+
+.IP D
+Discard
+
+.IP B
+Barrier
+
+.IP N
+Other operation
+
+.IP F
+Force Unit Access (FUA)
+
+.IP A
+Readahead
+
+.IP S
+Synchronous
+
+.IP M
+Meta
+
+.PP
+One of 'R', 'W', 'D', or 'N' is always present. The other characters are
+optional. Note that 'F' has two meanings, depending on its position.
 
 .SH "DEFAULT OUTPUT"
 
index 836ac4a35f867019623b11411de50bdc409070dd..d747de72f10010f9ca59c2a4ee1a7389f38d582c 100644 (file)
@@ -653,9 +653,24 @@ X & Split \\ \hline
 \end{tabular}
 
 \subsubsection{\label{sec:act-table}RWBS Description}
-This is a small string containing at least one character ('R' for read,
-'W' for write, or 'D' for block discard operation), and optionally either
-a 'B' (for barrier operations) or 'S' (for synchronous operations).
+This is a small string containing characters in the following order:
+
+\begin{tabular}{|l|l|}\hline
+Character & Description \\ \hline\hline
+F & Flush \\ \hline
+R & Read \\ \hline
+W & Write \\ \hline
+D & Discard \\ \hline
+B & Barrier \\ \hline
+N & Other operation \\ \hline
+F & Force Unit Access (FUA) \\ \hline
+A & Readahead \\ \hline
+S & Synchronous \\ \hline
+M & Meta \\ \hline
+\end{tabular}
+
+One of 'R', 'W', 'D', or 'N' is always present. The other characters are
+optional. Note that 'F' has two meanings, depending on its position.
 
 \subsubsection{\label{sec:default-output}Default output}