[PATCH 1/4] hwclock: remove two comments about parameters that no longer exist

[PATCH 1/4] hwclock: remove two comments about parameters that no longer exist

[Benno Schulenberg]

Commit 336f7c5f68 from nine years ago removed the 'universal' and
'testing' parameters of do_adjustment() but forgot to update the
leading comment.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/hwclock.c | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/sys-utils/hwclock.c b/sys-utils/hwclock.c
index 9977e0600..7ae7fca11 100644
--- a/sys-utils/hwclock.c
+++ b/sys-utils/hwclock.c
@@ -943,11 +943,6 @@ done:
  * Hardware clock set time is subtracted from read_time to 'refer back', or
  * delay, the trigger point.  Fractional parts must be accounted for in this
  * way, because the Hardware Clock can only be set to a whole second.
- *
- * <universal>: the Hardware Clock is kept in UTC.
- *
- * <testing>:  We are running in test mode (no updating of clock).
- *
  */
 static void
 do_adjustment(const struct hwclock_control *ctl, struct adjtime *adjtime_p,
-- 
2.48.1

[PATCH 2/4] textual: fix a mistruncated message, and fix a typo

[Benno Schulenberg]

The phrase "in human-readable form" was chosen rather than
"in human-readable format" because it's shorter and lets
the line fit *just* within 80 columns.

Reported-by: Petr Písař <petr.pisar@atlas.cz>
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/lsipc.c   | 2 +-
 sys-utils/setpriv.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/sys-utils/lsipc.c b/sys-utils/lsipc.c
index 7b041790b..d292ab96c 100644
--- a/sys-utils/lsipc.c
+++ b/sys-utils/lsipc.c
@@ -338,7 +338,7 @@ static void __attribute__((__noreturn__)) usage(void)
 	fputs(_("     --noheadings         don't print headings\n"), out);
 	fputs(_("     --notruncate         don't truncate output\n"), out);
 	fputs(_("     --time-format=<type> display dates in short, full or iso format\n"), out);
-	fputs(_(" -b, --bytes              print SIZE in bytes rather\n"), out);
+	fputs(_(" -b, --bytes              print SIZE in bytes rather than in human-readable form\n"), out);
 	fputs(_(" -c, --creator            show creator and owner\n"), out);
 	fputs(_(" -e, --export             display in an export-able output format\n"), out);
 	fputs(_(" -J, --json               use the JSON output format\n"), out);
diff --git a/sys-utils/setpriv.c b/sys-utils/setpriv.c
index daa3ab366..433db6031 100644
--- a/sys-utils/setpriv.c
+++ b/sys-utils/setpriv.c
@@ -1025,7 +1025,7 @@ int main(int argc, char **argv)
 		case SECCOMP_FILTER:
 			if (opts.seccomp_filter)
 				errx(EXIT_FAILURE,
-				     _("duplicate --secccomp-filter option"));
+				     _("duplicate --seccomp-filter option"));
 			opts.seccomp_filter = optarg;
 			break;
 		case RESET_ENV:
-- 
2.48.1

[PATCH 3/4] zramctl: restore normal description indentations in the usage text

[Benno Schulenberg]

Commit 19c12e63b1 from four months ago changed the indentation of *all*
the option descriptions in the usage text.  That was the wrong thing to
do, as it invalidates all existing translations for no good reason.

When one of the options is (or needs to become) overlong, then the thing
to do is: to put the description of this option on the next line.

So, restore the indentation of the descriptions to what they were
before commit 19c12e63b1, and wrap the description of -p.

Also, make the description of -b fit within 80 columns, and sort the
options better: alphabetically, but single letter before long option.

CC: LiviaMedeiros <livia@cirno.name>
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/zramctl.c | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/sys-utils/zramctl.c b/sys-utils/zramctl.c
index 36cc55ff9..b9ea5998e 100644
--- a/sys-utils/zramctl.c
+++ b/sys-utils/zramctl.c
@@ -745,17 +745,18 @@ static void __attribute__((__noreturn__)) usage(void)
 	fputs(_("Set up and control zram devices.\n"), out);
 
 	fputs(USAGE_OPTIONS, out);
-	fputs(_(" -a, --algorithm <alg>              compression algorithm to use\n"), out);
-	fputs(_(" -b, --bytes                        print sizes in bytes rather than in human readable format\n"), out);
-	fputs(_(" -f, --find                         find a free device\n"), out);
-	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 <params>    algorithm parameters to use\n"), out);
-	fputs(_("     --raw                          use raw status output format\n"), out);
-	fputs(_(" -r, --reset                        reset all specified devices\n"), out);
-	fputs(_(" -s, --size <size>                  device size\n"), out);
-	fputs(_(" -t, --streams <number>             number of compression streams\n"), out);
+	fputs(_(" -a, --algorithm <alg>     compression algorithm to use\n"), out);
+	fputs(_(" -b, --bytes               print sizes in bytes, not in human-readable form\n"), out);
+	fputs(_(" -f, --find                find a free device\n"), out);
+	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"
+		"                           parameters for the compression algorithm\n"), out);
+	fputs(_(" -r, --reset               reset all specified 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);
 
 	fputs(USAGE_SEPARATOR, out);
 	fprintf(out, USAGE_HELP_OPTIONS(27));
-- 
2.48.1

[PATCH 4/4] zramctl: (man) mention the required arguments for -p and -r

[Benno Schulenberg]

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

Re: [PATCH 1/4] hwclock: remove two comments about parameters that no longer exist

[Karel Zak]

On Sun, Apr 06, 2025 at 05:21:44PM +0200, Benno Schulenberg wrote:
>  sys-utils/hwclock.c | 5 -----
>  1 file changed, 5 deletions(-)

All four patches have been applied. Thank you!

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com