From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Heinrich Schuchardt <xypron.glpk@gmx.de>,
Eugene Syromyatnikov <evgsyr@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man <linux-man@vger.kernel.org>,
Mike Christie <mchristi@redhat.com>,
lkml <linux-kernel@vger.kernel.org>,
Linux API <linux-api@vger.kernel.org>
Subject: Removal of the ioctl_list(2) manual page (was: Re: ioctl_list.2: complete overhaul needed)
Date: Thu, 16 Apr 2020 09:10:43 +0200 [thread overview]
Message-ID: <ebd773bc-1277-c346-3edc-370c843cc968@gmail.com> (raw)
In-Reply-To: <5e9b4408-410f-6fb4-9c8b-0bd68e64577d@gmx.de>
[CC widened]
Hello Heinrich, Eugene,
On 4/14/20 6:21 PM, Heinrich Schuchardt wrote:
> On 2020-04-14 17:37, Eugene Syromyatnikov wrote:
>> On Tue, Apr 14, 2020 at 5:18 PM Michael Kerrisk (man-pages)
>> <mtk.manpages@gmail.com> wrote:
>>>
>>> Hello Heinrich,
>>>
>>> On Sun, 9 Nov 2014 at 16:52, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
[...]
>>> As you suggest, I've removed the hex values from the lists.
>>
>> Those can be replaced with the _IO* macro definitions. Meanwhile, the
>> list is somewhat far from complete; strace has some approximation that
>> can be uses a basis of a more complete and reliable list
>> (linux/{32,64}/ioctls_inc*.h and linux/*/ioctls_arch*.h), but I'm not
>> sure if it is worth adding to the man page (moreover, entries are
>> constantly being added and changed there; yes, breaking the kernel ABI
>> in the process sometimes).
>
> Man-pages like netdevices.7 or ioctl_fat.2 are what is needed to help a
> user who does not want to read through the kernel code.
>
> If ioctl_list.2 has not been reasonably maintained since Linux 1.3.27
> and hence is not a reliable source of information, shouldn't it be dropped?
As already noted, I'm inclined to agree that yes, this page probably
should be removed. What really is needed is pages such as ioctl_fat(2),
ioctl_userfaultfd(2), and ioctl_ns(2) that give useful details
to user-space programmers.
Just FYI, I've queued a change that removes the ioctl_list(2) page
in a private branch. By the time of the next release, I'll merge
that branch, unless someone has (good) objections.
There is one piece of ioctl_list(2) that is perhaps worth preserving:
the "ioctl structure" subsection. As part of these changes, I've
migrated that text to ioctl(2).
Cheers,
Michael
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
prev parent reply other threads:[~2020-04-16 7:10 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-11-09 15:50 ioctl_list.2: complete overhaul needed Heinrich Schuchardt
[not found] ` <545F8D2E.5030308-Mmb7MZpHnFY@public.gmane.org>
2014-11-11 7:14 ` Michael Kerrisk (man-pages)
[not found] ` <5461B768.7040603-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-11-11 7:52 ` Mike Frysinger
[not found] ` <20141111075242.GB28132-eAEk4k+vi/E8xmjh+jFwDmGXanvQGlWp@public.gmane.org>
2014-11-11 8:18 ` Michael Kerrisk (man-pages)
2020-04-14 11:07 ` Michael Kerrisk (man-pages)
2020-04-14 15:37 ` Eugene Syromyatnikov
2020-04-14 16:21 ` Heinrich Schuchardt
2020-04-15 6:48 ` Michael Kerrisk (man-pages)
2020-04-16 7:10 ` Michael Kerrisk (man-pages) [this message]
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=ebd773bc-1277-c346-3edc-370c843cc968@gmail.com \
--to=mtk.manpages@gmail.com \
--cc=evgsyr@gmail.com \
--cc=linux-api@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=mchristi@redhat.com \
--cc=xypron.glpk@gmx.de \
/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