diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 17:57:43 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 18:06:28 +0300 |
| commit | 706f8a9975cb8889742d1f606ff466205ed29805 (patch) | |
| tree | 53f11f25ecbab359cfa29e56c0effff67e4c0500 /Documentation/media/uapi/gen-errors.rst | |
| parent | fed7b888f69f70fc35c184677b2e8f59cb3945cb (diff) | |
| download | linux-706f8a9975cb8889742d1f606ff466205ed29805.tar.xz | |
[media] doc-rst: improve display of notes and warnings
There are several notes and warning mesages in the middle of
the media docbook. Use the ReST tags for that, as it makes
them visually better and hightlights them.
While here, modify a few ones to make them clearer.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/gen-errors.rst')
| -rw-r--r-- | Documentation/media/uapi/gen-errors.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Documentation/media/uapi/gen-errors.rst b/Documentation/media/uapi/gen-errors.rst index 6cd5d26f32ab..d6b0cfd00a3f 100644 --- a/Documentation/media/uapi/gen-errors.rst +++ b/Documentation/media/uapi/gen-errors.rst @@ -92,10 +92,12 @@ Generic Error Codes - Permission denied. Can be returned if the device needs write permission, or some special capabilities is needed (e. g. root) +.. note:: -Note 1: ioctls may return other error codes. Since errors may have side -effects such as a driver reset, applications should abort on unexpected -errors. + #. This list is not exaustive; ioctls may return other error codes. + Since errors may have side effects such as a driver reset, + applications should abort on unexpected errors, or otherwise + assume that the device is in a bad state. -Note 2: Request-specific error codes are listed in the individual -requests descriptions. + #. Request-specific error codes are listed in the individual + requests descriptions. |