Util-Linux package development
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Subject: [PATCH 4/8] blkzone: (man) reduce two overblown tables to legible proportions
Date: Mon,  7 Apr 2025 17:14:35 +0200	[thread overview]
Message-ID: <20250407151503.23394-4-bensberg@telfort.nl> (raw)
In-Reply-To: <20250407151503.23394-1-bensberg@telfort.nl>

Before version 2.37, before asciidoctor was used, the first three lines
of the first table looked like this:

       start     Zone start sector
       len       Zone length in number of sectors
       wptr      Zone write pointer position

After the move to asciidoctor, the first three lines of the first table
in the generated man page looked like this:

       ┌────────┬────────────────────────────┐
       │        │                            │
       │start   │ Zone start sector          │
       ├────────┼────────────────────────────┤
       │        │                            │
       │len     │ Zone length in number of   │
       │        │ sectors                    │
       ├────────┼────────────────────────────┤
       │        │                            │
       │wptr    │ Zone write pointer         │
       │        │ position                   │
       ├────────┼────────────────────────────┤

Three to four screen lines for just one line of information!

Reduce the tables to sane proportions again by simply using blocks
of preformatted text.

(The substition of xN for x? is needed because somehow the ? in the
indented text is a special character in groff.)

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/blkzone.8.adoc | 44 +++++++++++++++++++---------------------
 1 file changed, 21 insertions(+), 23 deletions(-)

diff --git a/sys-utils/blkzone.8.adoc b/sys-utils/blkzone.8.adoc
index 8456b5e42..ac5413ed0 100644
--- a/sys-utils/blkzone.8.adoc
+++ b/sys-utils/blkzone.8.adoc
@@ -29,31 +29,29 @@ The command *blkzone report* is used to report device zone information.
 By default, the command will report all zones from the start of the block device. Options may be used to modify this behavior, changing the starting zone or the size of the report, as explained below.
 
 Report output:
-[cols=",",]
-|===
-|start |Zone start sector
-|len |Zone length in number of sectors
-|cap |Zone capacity in number of sectors
-|wptr |Zone write pointer position
-|reset |Reset write pointer recommended
-|non-seq |Non-sequential write resources active
-|cond |Zone condition
-|type |Zone type
-|===
+....
+ start      Zone start sector
+ len        Zone length in number of sectors
+ cap        Zone capacity in number of sectors
+ wptr       Zone write pointer position
+ reset      Reset write pointer recommended
+ non-seq    Non-sequential write resources active
+ cond       Zone condition
+ type       Zone type
+....
 
 Zone conditions:
-[cols=",",]
-|===
-|cl |Closed
-|nw |Not write pointer
-|em |Empty
-|fu |Full
-|oe |Explicitly opened
-|oi |Implicitly opened
-|ol |Offline
-|ro |Read only
-|x? |Reserved conditions (should not be reported)
-|===
+....
+ cl    Closed
+ nw    Not write pointer
+ em    Empty
+ fu    Full
+ oe    Explicitly opened
+ oi    Implicitly opened
+ ol    Offline
+ ro    Read only
+ xN    Reserved conditions (should not be reported)
+....
 
 === capacity
 
-- 
2.48.1


  parent reply	other threads:[~2025-04-07 15:15 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-07 15:14 [PATCH 1/8] setarch: (man) remove a synopsis line that mistakenly mentions `arch` Benno Schulenberg
2025-04-07 15:14 ` [PATCH 2/8] choom: (man) add the missing SYNOPSIS section header, and improve wording Benno Schulenberg
2025-04-07 15:14 ` [PATCH 3/8] hexdump: (man) normalize the synopsis, and shrink a list and two tables Benno Schulenberg
2025-04-07 15:14 ` Benno Schulenberg [this message]
2025-04-07 15:14 ` [PATCH 5/8] eject: (man) add the missing SYNOPSIS header Benno Schulenberg
2025-04-07 15:14 ` [PATCH 6/8] mount: (man) fix some indentation issues, and improve a few wordings Benno Schulenberg
2025-04-07 15:14 ` [PATCH 7/8] mount: (man) shorten an overlong line, and improve some markup Benno Schulenberg
2025-04-07 15:14 ` [PATCH 8/8] column: (man) fix broken markup, and improve other markup and wordings Benno Schulenberg
2025-04-08 10:33 ` [PATCH 1/8] setarch: (man) remove a synopsis line that mistakenly mentions `arch` Karel Zak
2025-04-08 12:35   ` Chris Hofstaedtler
2025-04-08 13:24     ` Karel Zak
2025-04-09  9:36   ` Benno Schulenberg
2025-04-08 10:47 ` Karel Zak

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=20250407151503.23394-4-bensberg@telfort.nl \
    --to=bensberg@telfort.nl \
    --cc=util-linux@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