From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: "Kai Mäkisara (Kolumbus)" <kai.makisara@kolumbus.fi>
Cc: Helge Kreutzmann <debian@helgefjell.de>,
linux-man <linux-man@vger.kernel.org>
Subject: Re: Errors in man pages, here: st.4.po: Wording
Date: Mon, 20 Apr 2020 21:41:45 +0200 [thread overview]
Message-ID: <CAKgNAkiS_OSQadsT+Tj_LM8iUPC+4pT3RLrCU0Yj3Hd1vMR50w@mail.gmail.com> (raw)
In-Reply-To: <7FA79E79-F535-41C7-874C-067DA41E07D8@kolumbus.fi>
Hello Kai,
On Mon, 20 Apr 2020 at 20:49, "Kai Mäkisara (Kolumbus)"
<kai.makisara@kolumbus.fi> wrote:
>
> Hello,
>
> > On 20. Apr 2020, at 21.25, Michael Kerrisk (man-pages) <mtk.manpages@gmail.com> wrote:
> >
> > Hello Kai,
> >
> > On Mon, 20 Apr 2020 at 17:59, "Kai Mäkisara (Kolumbus)"
> > <kai.makisara@kolumbus.fi> wrote:
> >>
> >>
> >>
> >>> On 20. Apr 2020, at 12.48, Michael Kerrisk (man-pages) <mtk.manpages@gmail.com> wrote:
> >>>
> >>> [CC += Kai]
> >>>
> >>> On 4/19/20 8:48 AM, Helge Kreutzmann wrote:
> >>>> Dear manpages maintainers.
> >>>>
> >> ...
> >>>> **
> >>>>
> >>>> media → data
> >>>>
> >>>> msgid "Go to the end of the recorded media (for appending files)."
> >>>>
> >> End of media is the end of the tape. End of recorded media means
> >> after the last record/filemark that has been written to the tape. Usually
> >> (not always) you can write more data after what has been written
> >> so far. End of recorded media is standard tape terminology.
> >>
> >>>> --
> >>>> drive → media
> >>>>
> >>>> "B<GMT_WR_PROT>(I<x>): The drive is write-protected. For some drives this "
> >>>> "can also mean that the drive does not support writing on the current medium "
> >>>> "type."
> >>>
> >> This basically means that the drive refuses to write to the media. It can be
> >> write-protected by the user. The additional text hints at the possibility
> >> that the drive can only read the media type in the drive. It is quite
> >> common that drives can read, for instance, several old formats
> >> (usually with smaller capacity) but can write only the newest types.
> >> Many times the user may not know very well the properties of the
> >> drive and wonders, why can’t I write even if the tape can be read
> >> and the write protect tab is off.
> >
> > So, if I understand right, then no changes to the wording are required?
> >
> I don’t think changes are necessarily needed. I don’t find any errors
> here. But when the text is not clear to readers, I always ask myself,
> should it be made clearer. I have understood that the man pages
> must be precise, but not too long. The requirements are different
> for the different sections of man pages. For instance, section 1 is
> meant for “ordinary” users but section 4 is for low-level interface
> to device drivers. I think we can assume that the users of
> section 4 have some technical knowledge about the device they
> are interested in programming.
Agreed.
> So, I don’t think changes are necessary. But I don’t object if someone
> wants to enhance the descriptions
> Okay.
> as long as they are precise and not too long.
Rather like your mails :-).
Thanks,
Michael
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
next prev parent reply other threads:[~2020-04-20 19:42 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-19 6:48 Errors in man pages, here: st.4.po: Wording Helge Kreutzmann
2020-04-20 9:48 ` Michael Kerrisk (man-pages)
2020-04-20 15:59 ` "Kai Mäkisara (Kolumbus)"
2020-04-20 18:25 ` Michael Kerrisk (man-pages)
2020-04-20 18:49 ` "Kai Mäkisara (Kolumbus)"
2020-04-20 19:41 ` Michael Kerrisk (man-pages) [this message]
2020-05-01 7:11 ` Helge Kreutzmann
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=CAKgNAkiS_OSQadsT+Tj_LM8iUPC+4pT3RLrCU0Yj3Hd1vMR50w@mail.gmail.com \
--to=mtk.manpages@gmail.com \
--cc=debian@helgefjell.de \
--cc=kai.makisara@kolumbus.fi \
--cc=linux-man@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).