Util-Linux package development
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Subject: [PATCH 4/4] zramctl: (man) mention the required arguments for -p and -r
Date: Sun,  6 Apr 2025 17:21:47 +0200	[thread overview]
Message-ID: <20250406152147.9225-4-bensberg@telfort.nl> (raw)
In-Reply-To: <20250406152147.9225-1-bensberg@telfort.nl>

Also, sort the options strictly alphabetically ("r" before "raw").

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/zramctl.8.adoc | 15 +++++++++------
 sys-utils/zramctl.c      |  4 ++--
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/sys-utils/zramctl.8.adoc b/sys-utils/zramctl.8.adoc
index 4cc402e5c..c08f1e005 100644
--- a/sys-utils/zramctl.8.adoc
+++ b/sys-utils/zramctl.8.adoc
@@ -54,18 +54,21 @@ Define the status output columns to be used. If no output arrangement is specifi
 +
 The default list of columns may be extended if _list_ is specified in the format _+list_ (e.g., *zramctl -o+COMP-RATIO*).
 
-*-p*, *--algorithm-params*::
-Set the algorithm parameters, for example, *level=9 dict=/etc/dictionary* to set compression level and pre-trained dictionary. Parameters are algorithm specific.
-
 *--output-all*::
 Output all available columns.
 
+*-p*, *--algorithm-params* _parameter_...::
+Specify the parameters for the selected compression algorithm.
+For example, *level=9 dict=/etc/dictionary* sets the compression level
+and pre-trained dictionary. Parameters are algorithm-specific.
+
+*-r*, *--reset* _zramdev_...::
+Reset the specified zram device(s).
+The settings of a zram device can be changed only after a reset.
+
 *--raw*::
 Use the raw format for status output.
 
-*-r*, *--reset*::
-Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset.
-
 *-s*, *--size* _size_::
 Create a zram device of the specified _size_. Zram devices are aligned to memory pages; when the requested _size_ is not a multiple of the page size, it will be rounded up to the next multiple. When not otherwise specified, the unit of the _size_ parameter is bytes.
 +
diff --git a/sys-utils/zramctl.c b/sys-utils/zramctl.c
index b9ea5998e..fdb173ea5 100644
--- a/sys-utils/zramctl.c
+++ b/sys-utils/zramctl.c
@@ -751,9 +751,9 @@ static void __attribute__((__noreturn__)) usage(void)
 	fputs(_(" -n, --noheadings          don't print headings\n"), out);
 	fputs(_(" -o, --output <list>       columns to use for status output\n"), out);
 	fputs(_("     --output-all          output all columns\n"), out);
-	fputs(_(" -p, --algorithm-params <parameters>\n"
+	fputs(_(" -p, --algorithm-params <parameter>...\n"
 		"                           parameters for the compression algorithm\n"), out);
-	fputs(_(" -r, --reset               reset all specified devices\n"), out);
+	fputs(_(" -r, --reset <device>...   reset the specified zram devices\n"), out);
 	fputs(_("     --raw                 use raw status output format\n"), out);
 	fputs(_(" -s, --size <size>         device size\n"), out);
 	fputs(_(" -t, --streams <number>    number of compression streams\n"), out);
-- 
2.48.1


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

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-06 15:21 [PATCH 1/4] hwclock: remove two comments about parameters that no longer exist Benno Schulenberg
2025-04-06 15:21 ` [PATCH 2/4] textual: fix a mistruncated message, and fix a typo Benno Schulenberg
2025-04-06 15:21 ` [PATCH 3/4] zramctl: restore normal description indentations in the usage text Benno Schulenberg
2025-04-06 15:21 ` Benno Schulenberg [this message]
2025-04-08 11:44 ` [PATCH 1/4] hwclock: remove two comments about parameters that no longer exist 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=20250406152147.9225-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