From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Madhavan Srinivasan <maddy@linux.ibm.com>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Haren Myneni <haren@linux.ibm.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Andrew Donnellan <ajd@linux.ibm.com>,
Michael Ellerman <mpe@ellerman.id.au>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Subject: [PATCH 1/2] Documentation: ioctl-number: Shorten macros table
Date: Tue, 15 Jul 2025 09:42:57 +0700 [thread overview]
Message-ID: <20250715024258.16882-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250715024258.16882-1-bagasdotme@gmail.com>
The macros table has three columns: the second one is "an" and the
third one writes "an ioctl with ... parameters". Simplify the table
by adding heading row that indicates macro name and accepted
parameters.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/userspace-api/ioctl/ioctl-number.rst | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst
index bc91756bde733b..ad5e7001f59137 100644
--- a/Documentation/userspace-api/ioctl/ioctl-number.rst
+++ b/Documentation/userspace-api/ioctl/ioctl-number.rst
@@ -10,12 +10,14 @@ Michael Elizabeth Chastain
If you are adding new ioctl's to the kernel, you should use the _IO
macros defined in <linux/ioctl.h>:
- ====== == ============================================
- _IO an ioctl with no parameters
- _IOW an ioctl with write parameters (copy_from_user)
- _IOR an ioctl with read parameters (copy_to_user)
- _IOWR an ioctl with both write and read parameters.
- ====== == ============================================
+ ====== ===========================
+ macro parameters
+ ====== ===========================
+ _IO none
+ _IOW write (read from userspace)
+ _IOR read (write to userpace)
+ _IOWR write and read
+ ====== ===========================
'Write' and 'read' are from the user's point of view, just like the
system calls 'write' and 'read'. For example, a SET_FOO ioctl would
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2025-07-15 2:43 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-15 2:42 [PATCH 0/2] Documentation: ioctl-number: DRY cleanup Bagas Sanjaya
2025-07-15 2:42 ` Bagas Sanjaya [this message]
2025-07-15 2:42 ` [PATCH 2/2] Documentation: ioctl-number: Don't repeat macro names Bagas Sanjaya
2025-07-15 20:05 ` [PATCH 0/2] Documentation: ioctl-number: DRY cleanup Jonathan Corbet
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=20250715024258.16882-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=ajd@linux.ibm.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=haren@linux.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maddy@linux.ibm.com \
--cc=mchehab+huawei@kernel.org \
--cc=mpe@ellerman.id.au \
/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).