From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>,
linux-kernel@vger.kernel.org
Subject: [PATCH v3 04/16] docs: driver-api: ioctl.rst: replace some characters
Date: Sun, 16 May 2021 12:18:21 +0200 [thread overview]
Message-ID: <218839a44e1bb3332fbcf5bcf03e7700ff1ab679.1621159997.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1621159997.git.mchehab+huawei@kernel.org>
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.
Replace the occurences of the following characters:
- U+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/driver-api/ioctl.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/driver-api/ioctl.rst b/Documentation/driver-api/ioctl.rst
index c455db0e1627..5b76e765827d 100644
--- a/Documentation/driver-api/ioctl.rst
+++ b/Documentation/driver-api/ioctl.rst
@@ -25,9 +25,9 @@ ioctl commands that follow modern conventions: ``_IO``, ``_IOR``,
with the correct parameters:
_IO/_IOR/_IOW/_IOWR
- The macro name specifies how the argument will be used. It may be a
+ The macro name specifies how the argument will be used. It may be a
pointer to data to be passed into the kernel (_IOW), out of the kernel
- (_IOR), or both (_IOWR). _IO can indicate either commands with no
+ (_IOR), or both (_IOWR). _IO can indicate either commands with no
argument or those passing an integer value instead of a pointer.
It is recommended to only use _IO for commands without arguments,
and use pointers for passing data.
@@ -200,10 +200,10 @@ cause an information leak, which can be used to defeat kernel address
space layout randomization (KASLR), helping in an attack.
For this reason (and for compat support) it is best to avoid any
-implicit padding in data structures. Where there is implicit padding
+implicit padding in data structures. Where there is implicit padding
in an existing structure, kernel drivers must be careful to fully
initialize an instance of the structure before copying it to user
-space. This is usually done by calling memset() before assigning to
+space. This is usually done by calling memset() before assigning to
individual members.
Subsystem abstractions
--
2.31.1
next prev parent reply other threads:[~2021-05-16 10:18 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-16 10:18 [PATCH v3 00/16] Replace some bad characters on documents Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 01/16] docs: hwmon: ir36021.rst: replace some characters Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 02/16] docs: admin-guide: reporting-issues.rst: " Mauro Carvalho Chehab
2021-05-16 10:28 ` Thorsten Leemhuis
2021-05-16 11:13 ` Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 03/16] docs: trace: coresight: coresight-etm4x-reference.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` Mauro Carvalho Chehab [this message]
2021-05-16 10:18 ` [PATCH v3 05/16] docs: driver-api: media: drivers: zoran.rst: " Mauro Carvalho Chehab
2021-05-16 18:32 ` LABBE Corentin
2021-05-16 10:18 ` [PATCH v3 06/16] docs: usb: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 07/16] docs: userspace-api: media: v4l: dev-decoder.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 08/16] docs: userspace-api: media: dvb: intro.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 09/16] docs: vm: zswap.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 10/16] docs: filesystems: ext4: blockgroup.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 11/16] docs: networking: device_drivers: " Mauro Carvalho Chehab
2021-05-17 16:11 ` Jesse Brandeburg
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: " Mauro Carvalho Chehab
2021-05-19 21:47 ` Bjorn Helgaas
2021-06-16 6:51 ` Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 13/16] docs: sound: kernel-api: writing-an-alsa-driver.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 14/16] docs: firmware-guide: acpi: dsd: graph.rst: " Mauro Carvalho Chehab
2021-05-17 14:20 ` Rafael J. Wysocki
2021-05-16 10:18 ` [PATCH v3 15/16] docs: virt: kvm: api.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 16/16] docs: RCU: " Mauro Carvalho Chehab
2021-05-17 10:53 ` Akira Yokosawa
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
2021-05-17 11:24 ` Mauro Carvalho Chehab
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=218839a44e1bb3332fbcf5bcf03e7700ff1ab679.1621159997.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@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).