Commit 08047562 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

doc-rst: linux_tv: fix some warnings due to '*'

Unescaped * causes warnings on Sphinx.

Add an escape at hist-v4l2 occurrences.

At libv4l-introduction, the best is do declare the function
prototypes as C code.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent e4aadf72
...@@ -187,7 +187,7 @@ common Linux driver API conventions. ...@@ -187,7 +187,7 @@ common Linux driver API conventions.
until the time in the timestamp field has arrived. I would like to until the time in the timestamp field has arrived. I would like to
follow SGI's lead, and adopt a multimedia timestamping system like follow SGI's lead, and adopt a multimedia timestamping system like
their UST (Unadjusted System Time). See their UST (Unadjusted System Time). See
http://web.archive.org/web/*/http://reality.sgi.com http://web.archive.org/web/\*/http://reality.sgi.com
/cpirazzi_engr/lg/time/intro.html. UST uses timestamps that are /cpirazzi_engr/lg/time/intro.html. UST uses timestamps that are
64-bit signed integers (not struct timeval's) and given in nanosecond 64-bit signed integers (not struct timeval's) and given in nanosecond
units. The UST clock starts at zero when the system is booted and units. The UST clock starts at zero when the system is booted and
...@@ -1408,13 +1408,12 @@ XFree86 and XOrg, just programming any overlay capable Video4Linux ...@@ -1408,13 +1408,12 @@ XFree86 and XOrg, just programming any overlay capable Video4Linux
device it finds. To enable it ``/etc/X11/XF86Config`` must contain these device it finds. To enable it ``/etc/X11/XF86Config`` must contain these
lines: lines:
:: ::
Section "Module" Section "Module"
Load "v4l" Load "v4l"
EndSection EndSection
As of XFree86 4.2 this driver still supports only V4L ioctls, however it As of XFree86 4.2 this driver still supports only V4L ioctls, however it
should work just fine with all V4L2 devices through the V4L2 should work just fine with all V4L2 devices through the V4L2
backward-compatibility layer. Since V4L2 permits multiple opens it is backward-compatibility layer. Since V4L2 permits multiple opens it is
......
...@@ -116,42 +116,42 @@ The common file operation methods are provided by libv4l. ...@@ -116,42 +116,42 @@ The common file operation methods are provided by libv4l.
Those functions operate just like glibc Those functions operate just like glibc
open/close/dup/ioctl/read/mmap/munmap: open/close/dup/ioctl/read/mmap/munmap:
- int v4l2_open(const char *file, int oflag, ...) - operates like the - :c:type:`int v4l2_open(const char *file, int oflag, ...)` - operates like the
standard :ref:`open() <func-open>` function. standard :ref:`open() <func-open>` function.
- int v4l2_close(int fd) - operates like the standard - :c:type:`int v4l2_close(int fd)` - operates like the standard
:ref:`close() <func-close>` function. :ref:`close() <func-close>` function.
- int v4l2_dup(int fd) - operates like the standard dup() function, - :c:type:`int v4l2_dup(int fd)` - operates like the standard dup() function,
duplicating a file handler. duplicating a file handler.
- int v4l2_ioctl (int fd, unsigned long int request, ...) - operates - :c:type:`int v4l2_ioctl (int fd, unsigned long int request, ...)` - operates
like the standard :ref:`ioctl() <func-ioctl>` function. like the standard :ref:`ioctl() <func-ioctl>` function.
- int v4l2_read (int fd, void* buffer, size_t n) - operates like the - :c:type:`int v4l2_read (int fd, void* buffer, size_t n)` - operates like the
standard :ref:`read() <func-read>` function. standard :ref:`read() <func-read>` function.
- void v4l2_mmap(void *start, size_t length, int prot, int flags, int - :c:type:`void v4l2_mmap(void *start, size_t length, int prot, int flags, int
fd, int64_t offset); - operates like the standard fd, int64_t offset);` - operates like the standard
:ref:`mmap() <func-mmap>` function. :ref:`mmap() <func-mmap>` function.
- int v4l2_munmap(void *_start, size_t length); - operates like the - :c:type:`int v4l2_munmap(void *_start, size_t length);` - operates like the
standard :ref:`munmap() <func-munmap>` function. standard :ref:`munmap() <func-munmap>` function.
Those functions provide additional control: Those functions provide additional control:
- int v4l2_fd_open(int fd, int v4l2_flags) - opens an already opened - :c:type:`int v4l2_fd_open(int fd, int v4l2_flags)` - opens an already opened
fd for further use through v4l2lib and possibly modify libv4l2's fd for further use through v4l2lib and possibly modify libv4l2's
default behavior through the v4l2_flags argument. Currently, default behavior through the v4l2_flags argument. Currently,
v4l2_flags can be ``V4L2_DISABLE_CONVERSION``, to disable format v4l2_flags can be ``V4L2_DISABLE_CONVERSION``, to disable format
conversion. conversion.
- int v4l2_set_control(int fd, int cid, int value) - This function - :c:type:`int v4l2_set_control(int fd, int cid, int value)` - This function
takes a value of 0 - 65535, and then scales that range to the actual takes a value of 0 - 65535, and then scales that range to the actual
range of the given v4l control id, and then if the cid exists and is range of the given v4l control id, and then if the cid exists and is
not locked sets the cid to the scaled value. not locked sets the cid to the scaled value.
- int v4l2_get_control(int fd, int cid) - This function returns a - :c:type:`int v4l2_get_control(int fd, int cid)` - This function returns a
value of 0 - 65535, scaled to from the actual range of the given v4l value of 0 - 65535, scaled to from the actual range of the given v4l
control id. when the cid does not exist, could not be accessed for control id. when the cid does not exist, could not be accessed for
some reason, or some error occurred 0 is returned. some reason, or some error occurred 0 is returned.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment