leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: driver-api: ioctl.rst: replace some characters

Browse Source 
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>
Link: https://lore.kernel.org/r/b2186e313f990488ded56d9b8d35a2d1fe479aa1.1623826294.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab
2021-06-16 08:55:09 +02:00
committed by Jonathan Corbet
parent 90f40f514f
commit f40c2a25b9
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/driver-api/ioctl.rst
View File

@@ -25,9 +25,9 @@ ioctl commands that follow modern conventions: ``_IO``, ``_IOR``,
with the correct parameters: with the correct parameters:
_IO/_IOR/_IOW/_IOWR _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 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. argument or those passing an integer value instead of a pointer.
It is recommended to only use _IO for commands without arguments, It is recommended to only use _IO for commands without arguments,
and use pointers for passing data. 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. space layout randomization (KASLR), helping in an attack.
For this reason (and for compat support) it is best to avoid any 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 in an existing structure, kernel drivers must be careful to fully
initialize an instance of the structure before copying it to user 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. individual members.
Subsystem abstractions Subsystem abstractions