Skip to content

blktrace: doc updates, small fixes, small features

Steffen Maier linux-btrace 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest31 patches 3 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/31btt: doc: PDF output with bookmark structure and clickable cross referencesbtt/doc/Makefile btt/doc/btt.tex+96 -480 replies
2/31btt: doc: small fixesbtt/doc/btt.tex doc/btt.1+29 -160 replies
3/31btrace: fix usage by adding -h (blkparse --hash-by-name)btrace doc/btrace.8+6 -20 replies
4/31btrace: fix usage by adding -v (blkparse --verbose)btrace doc/btrace.8+6 -20 replies
5/31btrace: man: improve by pointing to blkparse for option -r (debugfs)doc/btrace.8+1 -10 replies
6/31blkrawverify: man: fix input format, reports written unconditionallydoc/blkrawverify.1+2 -10 replies
7/31verify_blkparse: man: document prereq and behaviordoc/verify_blkparse.1+12 -00 replies
8/31blkparse: man: fix typos and formatting, complete and update informationdoc/blkparse.1+187 -1140 replies
9/31blktrace: man: fix typos and formatting, complete and update informationdoc/blktrace.8+49 -260 replies
10/31blktrace: doc: PDF output with bookmark structure and clickable cross referencesdoc/Makefile doc/blktrace.tex+44 -220 replies
11/31blktrace: doc: add table of contents to show document structuredoc/blktrace.tex+3 -10 replies
12/31blktrace: doc: blktrace: sync fixes from man page updatesdoc/blktrace.tex+27 -200 replies
13/31blktrace: doc: blkparse: sync fixes from man page updatesdoc/blktrace.tex+129 -800 replies
14/31blktrace: doc: (un)plug event updates for on-stack pluggingdoc/blkparse.1 doc/blktrace.tex+20 -70 replies
15/31blktrace: doc: update RWBS including flush, FUA replacing barrierdoc/blkparse.1 doc/blktrace.8 doc/blktrace.tex+55 -30 replies
16/31blktrace: doc: no more SCSI CDB in payloaddoc/blktrace.8 doc/blktrace.tex+26 -00 replies
17/31blktrace: doc: assorted fixes and updatesdoc/blktrace.tex+150 -190 replies
18/31blktrace: doc: alternatives to blktrace traditional toolingdoc/blktrace.tex+397 -03 replies
19/31README: complete tool overviewREADME+55 -00 replies
20/31README: remove incomplete tool option descriptionsREADME+4 -910 replies
21/31btt: fix --do-active to not perform --q2d-latencies|-zbtt/args.c+1 -10 replies
22/31blkrawverify: fix dumping of erroneous traceblkrawverify.c+3 -30 replies
23/31blkparse: fix allowed event type specifiers for custom output formatblkparse_fmt.c+1 -10 replies
24/31verify_blkparse: inform on bad line, report line noverify_blkparse.c+10 -20 replies
25/31btrace: bring back possibility to toggle statistics at end of tracebtrace doc/blktrace.tex doc/btrace.8+10 -30 replies
26/31blkparse: treat sector as %llu for custom format like elsewhere in codeblkparse_fmt.c+2 -10 replies
27/31blkparse: elapsed time: change unit of custom format, no exit on noneblkparse_fmt.c doc/blkparse.1 doc/blktrace.tex+4 -60 replies
28/31blkparse: add custom format for calendar date of time stampblkparse_fmt.c doc/blkparse.1 doc/blktrace.tex+20 -20 replies
29/31blkparse: enable custom output format also for message event typeblkparse.c blkparse_fmt.c doc/blkparse.1 +1 more+13 -110 replies
30/31blkparse: add custom format field specifiers for remapping eventblkparse_fmt.c doc/blkparse.1 doc/blktrace.tex+37 -90 replies
31/31blkparse: new option to customize format of default output header onlyblkparse.c blkparse_fmt.c blktrace.h +3 more+55 -70 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/31] blktrace: doc updates, small fixes, small features

Hi Jens,

I needed to follow practical block I/O request behavior and was new to blktrace. So I read the docs, noted down where I had questions, did code history research, and collected my experience during practical use. This is the result, hoping somebody else might find it useful.

Patches 1-20 are documentation updates (incl. tool usage output).

While I synchronized the man page updates mostly into blktrace.tex, some things such as option details did not fit nicely into the latex tables. Removing the 2 reference sections for blktrace(8) and blkparse(1) from the tex file and instead referring to the man pages would be an option to avoid sync issues. But then again, I guess the tex file was the origin for the man pages in the first place.

Patches 21-23 are small bugfixes.

Patches 24-31 are small enhancements.

Steffen Maier (31):
btt: doc: PDF output with bookmark structure and clickable cross
references
btt: doc: small fixes
btrace: fix usage by adding -h (blkparse --hash-by-name)
btrace: fix usage by adding -v (blkparse --verbose)
btrace: man: improve by pointing to blkparse for option -r (debugfs)
blkrawverify: man: fix input format, reports written unconditionally
verify_blkparse: man: document prereq and behavior
blkparse: man: fix typos and formatting, complete and update
information
blktrace: man: fix typos and formatting, complete and update
information
blktrace: doc: PDF output with bookmark structure and clickable cross
references
blktrace: doc: add table of contents to show document structure
blktrace: doc: blktrace: sync fixes from man page updates
blktrace: doc: blkparse: sync fixes from man page updates
blktrace: doc: (un)plug event updates for on-stack plugging
blktrace: doc: update RWBS including flush, FUA replacing barrier
blktrace: doc: no more SCSI CDB in payload
blktrace: doc: assorted fixes and updates
blktrace: doc: alternatives to blktrace traditional tooling
README: complete tool overview
README: remove incomplete tool option descriptions
btt: fix --do-active to not perform --q2d-latencies|-z
blkrawverify: fix dumping of erroneous trace
blkparse: fix allowed event type specifiers for custom output format
verify_blkparse: inform on bad line, report line no
btrace: bring back possibility to toggle statistics at end of trace
blkparse: treat sector as %llu for custom format like elsewhere in
code
blkparse: elapsed time: change unit of custom format, no exit on none
blkparse: add custom format for calendar date of time stamp
blkparse: enable custom output format also for message event type
blkparse: add custom format field specifiers for remapping event
blkparse: new option to customize format of default output header only

 README                | 152 ++++----
 blkparse.c            |  22 +-
 blkparse_fmt.c        |  81 ++++-
 blkrawverify.c        |   6 +-
 blktrace.h            |   1 +
 btrace                |   5 +-
 btt/args.c            |   2 +-
 btt/doc/Makefile      |   2 +-
 btt/doc/btt.tex       | 183 ++++++----
 doc/Makefile          |   2 +-
 doc/blkparse.1        | 354 +++++++++++++------
 doc/blkrawverify.1    |   3 +-
 doc/blktrace.8        |  92 +++--
 doc/blktrace.tex      | 958 ++++++++++++++++++++++++++++++++++++++++++--------
 doc/btrace.8          |  16 +-
 doc/btt.1             |   2 +-
 doc/verify_blkparse.1 |  12 +
 verify_blkparse.c     |  12 +-
 18 files changed, 1430 insertions(+), 475 deletions(-)
Signature · 1 line
2.14.2