util-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Mario Blättermann" <mario.blaettermann@gmail.com>
To: Helge Kreutzmann <debian@helgefjell.de>
Cc: util-linux@vger.kernel.org
Subject: Re: Errors in man pages of util-linux
Date: Sun, 13 Feb 2022 19:33:07 +0100	[thread overview]
Message-ID: <CAHi0vA_7ZWjT=BY7Tc65N4sajBjkKd1LLbd1CmmYPWfgwWvg1A@mail.gmail.com> (raw)
In-Reply-To: <20220210203542.GA25645@Debian-50-lenny-64-minimal>

Hello,

Am Do., 10. Feb. 2022 um 21:35 Uhr schrieb Helge Kreutzmann
<debian@helgefjell.de>:
>
> Hello all,
> On Thu, Feb 10, 2022 at 08:23:41PM +0100, Helge Kreutzmann wrote:
> > I will send the issues in individual mails (like last time), without
> > this header. This will be a total of 84 mails.
> >
> > I'll wait with sending for ~ 1 hour in case you would not like to have
> > them in those e-mails.
>
> Mario asked me to provide the issues, therefor I send them to him
> directly for handling.
>

I've fixed most of the issues in my Github fork; see pull request
#1601. However, there's something left (my comments are in brackets):

--
Man page: hexdump.1
Issue:    superfluous citation around markup

"Output characters in the default character set. Non-printing characters are "
"displayed as a single \\(aqB<.>\\(aq."

"Further output by such format strings is replaced by an equivalent number of "
"spaces. An equivalent number of spaces is defined as the number of spaces "
"output by an B<s> conversion character with the same field width and "
"precision as the original conversion character or conversion string but with "
"any \\(aqB<+>\\(aq, \\(aq \\(aq, \\(aqB<#>\\(aq conversion flag characters "
"removed, and referencing a NULL string."

(I think it's better to keep the citation here to keep the dot apart
from the sentence ending, otherwise we get "..")
--
Man page: hwclock.8
Issue:    date-time → date time??

"There are two types of date-time clocks:"

(We have lots of occurences of this "date-time" thing. Don't know
whether it's good English or bad English …)
--
Man page: lsmem.1
Issue:    The first sentence is broken

"The B<lsmem> command lists a new memory range always when the current memory "
"block distinguish from the previous block by some output column. This "
"default behavior is possible to override by the B<--split> option (e.g., "
"B<lsmem --split=ZONES>). The special word \"none\" may be used to ignore all "
"differences between memory blocks and to create as large as possible "
"continuous ranges. The opposite semantic is B<--all> to list individual "

(Not sure what this means. I can't remember anymore why I wrote this
comment more than three years ago …)
--
Man page: mount.8
Issue:    ftp://ftp.namesys.com/pub/reiserfsprogs does not allow login

"A remount option which permits online expansion of reiserfs partitions. "
"Instructs reiserfs to assume that the device has I<number> blocks. This "
"option is designed for use with devices which are under logical volume "
"management (LVM). There is a special I<resizer> utility which can be "
"obtained from"

(The link gives a 404 error. I found a similar tool in the kernel
wiki: https://reiser4.wiki.kernel.org/index.php/Resize_reiserfs)
--
Man page: scriptreplay.1
Issue:    output doesn't match the real output exactly

"% script --log-timing file.tm --log-out script.out\n"
"Script started, file is script.out\n"
"% ls\n"
"E<lt>etc, etcE<gt>\n"
"% exit\n"
--
Man page: setarch.8
Issue:    arch → setarch?

"B<arch> [options] [I<program> [I<argument>...]]"

(Is "arch" still a synonym for "setarch"? With --help, I don't get "arch".)
----
Man page: unshare.1
Issue:    B<sleep> → B<sleep>(1)

"The B<pidof>(1) command prints no output, because the B<sleep> processes "
"have been killed. More precisely, when the B<sleep> process that has PID 1 "
"in the namespace (i.e., the namespace\\(cqs init process) was killed, this "
"caused all other processes in the namespace to be killed. By contrast, a "
"similar series of commands where the B<--kill-child> option is not used "
"shows that when B<unshare> terminates, the processes in the PID namespace "
"are not killed:"

(It's not about the "sleep" command, rather the processes; don't think it's
needed here to link to the man page.)
----

Your comments are welcome.

Best Regards,
Mario

  reply	other threads:[~2022-02-13 18:33 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-10 19:23 Errors in man pages of util-linux Helge Kreutzmann
2022-02-10 20:35 ` Helge Kreutzmann
2022-02-13 18:33   ` Mario Blättermann [this message]
2022-02-13 18:51     ` Helge Kreutzmann
2022-02-13 19:35       ` Bill Unruh
  -- strict thread matches above, loose matches on Subject: below --
2020-05-03 19:13 Helge Kreutzmann
2020-05-09 18:53 ` Michael Kerrisk
2020-05-09 19:00   ` Helge Kreutzmann
2020-05-09 19:05     ` Michael Kerrisk
2020-05-11  9:27       ` Karel Zak
2020-05-11  9:50         ` Helge Kreutzmann
2020-05-11 10:32         ` Michael Kerrisk (man-pages)

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='CAHi0vA_7ZWjT=BY7Tc65N4sajBjkKd1LLbd1CmmYPWfgwWvg1A@mail.gmail.com' \
    --to=mario.blaettermann@gmail.com \
    --cc=debian@helgefjell.de \
    --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;
as well as URLs for NNTP newsgroup(s).