[PATCH] cec: documentation fixes

2017-07-28 Thread Hans Verkuil 
Various references to open() et al were wrong. Fix this so following
the link will get you to the correct place.

Signed-off-by: Hans Verkuil 
---
 Documentation/media/uapi/cec/cec-func-close.rst  | 2 +-
 Documentation/media/uapi/cec/cec-func-ioctl.rst  | 2 +-
 Documentation/media/uapi/cec/cec-func-open.rst   | 4 ++--
 Documentation/media/uapi/cec/cec-func-poll.rst   | 8 
 Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst | 2 +-
 Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 2 +-
 6 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/media/uapi/cec/cec-func-close.rst 
b/Documentation/media/uapi/cec/cec-func-close.rst
index 895d9c2d1c04..334358dfa72e 100644
--- a/Documentation/media/uapi/cec/cec-func-close.rst
+++ b/Documentation/media/uapi/cec/cec-func-close.rst
@@ -40,7 +40,7 @@ freed. The device configuration remain unchanged.
 Return Value
 

-:c:func:`close()` returns 0 on success. On error, -1 is returned, and
+:c:func:`close() ` returns 0 on success. On error, -1 is returned, 
and
 ``errno`` is set appropriately. Possible error codes are:

 ``EBADF``
diff --git a/Documentation/media/uapi/cec/cec-func-ioctl.rst 
b/Documentation/media/uapi/cec/cec-func-ioctl.rst
index 22fb6304a2df..e2b6260b0086 100644
--- a/Documentation/media/uapi/cec/cec-func-ioctl.rst
+++ b/Documentation/media/uapi/cec/cec-func-ioctl.rst
@@ -39,7 +39,7 @@ Arguments
 Description
 ===

-The :c:func:`ioctl()` function manipulates cec device parameters. The
+The :c:func:`ioctl() ` function manipulates cec device parameters. 
The
 argument ``fd`` must be an open file descriptor.

 The ioctl ``request`` code specifies the cec function to be called. It
diff --git a/Documentation/media/uapi/cec/cec-func-open.rst 
b/Documentation/media/uapi/cec/cec-func-open.rst
index 18dfb62f2efe..5d6663a649bd 100644
--- a/Documentation/media/uapi/cec/cec-func-open.rst
+++ b/Documentation/media/uapi/cec/cec-func-open.rst
@@ -46,7 +46,7 @@ Arguments
 Description
 ===

-To open a cec device applications call :c:func:`open()` with the
+To open a cec device applications call :c:func:`open() ` with the
 desired device name. The function has no side effects; the device
 configuration remain unchanged.

@@ -58,7 +58,7 @@ EBADF.
 Return Value
 

-:c:func:`open()` returns the new file descriptor on success. On error,
+:c:func:`open() ` returns the new file descriptor on success. On 
error,
 -1 is returned, and ``errno`` is set appropriately. Possible error codes
 include:

diff --git a/Documentation/media/uapi/cec/cec-func-poll.rst 
b/Documentation/media/uapi/cec/cec-func-poll.rst
index fa0abd8fb160..d49f1ee0742d 100644
--- a/Documentation/media/uapi/cec/cec-func-poll.rst
+++ b/Documentation/media/uapi/cec/cec-func-poll.rst
@@ -39,10 +39,10 @@ Arguments
 Description
 ===

-With the :c:func:`poll()` function applications can wait for CEC
+With the :c:func:`poll() ` function applications can wait for CEC
 events.

-On success :c:func:`poll()` returns the number of file descriptors
+On success :c:func:`poll() ` returns the number of file descriptors
 that have been selected (that is, file descriptors for which the
 ``revents`` field of the respective struct :c:type:`pollfd`
 is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in
@@ -53,13 +53,13 @@ then the ``POLLPRI`` flag is set. When the function times 
out it returns
 a value of zero, on failure it returns -1 and the ``errno`` variable is
 set appropriately.

-For more details see the :c:func:`poll()` manual page.
+For more details see the :c:func:`poll() ` manual page.


 Return Value
 

-On success, :c:func:`poll()` returns the number structures which have
+On success, :c:func:`poll() ` returns the number structures which 
have
 non-zero ``revents`` fields, or zero if the call timed out. On error -1
 is returned, and the ``errno`` variable is set appropriately:

diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst 
b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
index 882d6e025747..0a7aa21f24f4 100644
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
@@ -21,7 +21,7 @@ Arguments
 =

 ``fd``
-File descriptor returned by :ref:`open() `.
+File descriptor returned by :c:func:`open() `.

 ``argp``

diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst 
b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
index 3e2cd5fefd38..766d8b0ce431 100644
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
@@ -22,7 +22,7 @@ Arguments
 =

 ``fd``
-File descriptor returned by :ref:`open() `.
+File descriptor returned by :c:func:`open() `.

 ``argp``

-- 
2.13.1

[PATCH] CEC documentation fixes

2017-02-17 Thread Hans Verkuil 

Fixed a few spelling mistakes, but mostly incorrect rst syntax that caused wrong
references or font style.

No actual documentation changes, just fixes.

Signed-off-by: Hans Verkuil 
---
diff --git a/Documentation/media/uapi/cec/cec-func-ioctl.rst 
b/Documentation/media/uapi/cec/cec-func-ioctl.rst
index 9e8dbb118d6a..071d18cec7b7 100644
--- a/Documentation/media/uapi/cec/cec-func-ioctl.rst
+++ b/Documentation/media/uapi/cec/cec-func-ioctl.rst
@@ -30,7 +30,7 @@ Arguments

 ``request``
 CEC ioctl request code as defined in the cec.h header file, for
-example :c:func:`CEC_ADAP_G_CAPS`.
+example :ref:`CEC_ADAP_G_CAPS `.

 ``argp``
 Pointer to a request-specific structure.
diff --git a/Documentation/media/uapi/cec/cec-func-open.rst 
b/Documentation/media/uapi/cec/cec-func-open.rst
index af3f5b5c24c6..5aab5cd345b1 100644
--- a/Documentation/media/uapi/cec/cec-func-open.rst
+++ b/Documentation/media/uapi/cec/cec-func-open.rst
@@ -33,7 +33,7 @@ Arguments
 Open flags. Access mode must be ``O_RDWR``.

 When the ``O_NONBLOCK`` flag is given, the
-:ref:`CEC_RECEIVE ` and :c:func:`CEC_DQEVENT` ioctls
+:ref:`CEC_RECEIVE ` and :ref:`CEC_DQEVENT ` 
ioctls
 will return the ``EAGAIN`` error code when no message or event is 
available, and
 ioctls :ref:`CEC_TRANSMIT `,
 :ref:`CEC_ADAP_S_PHYS_ADDR ` and
diff --git a/Documentation/media/uapi/cec/cec-func-poll.rst 
b/Documentation/media/uapi/cec/cec-func-poll.rst
index cfb73e6027a5..d48dee0f00d6 100644
--- a/Documentation/media/uapi/cec/cec-func-poll.rst
+++ b/Documentation/media/uapi/cec/cec-func-poll.rst
@@ -30,7 +30,7 @@ Arguments
List of FD events to be watched

 ``nfds``
-   Number of FD efents at the \*ufds array
+   Number of FD events at the \*ufds array

 ``timeout``
Timeout to wait for events
@@ -54,7 +54,7 @@ is non-zero). CEC devices set the ``POLLIN`` and 
``POLLRDNORM`` flags in
 the ``revents`` field if there are messages in the receive queue. If the
 transmit queue has room for new messages, the ``POLLOUT`` and
 ``POLLWRNORM`` flags are set. If there are events in the event queue,
-then the ``POLLPRI`` flag is set. When the function timed out it returns
+then the ``POLLPRI`` flag is set. When the function times out it returns
 a value of zero, on failure it returns -1 and the ``errno`` variable is
 set appropriately.

diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst 
b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
index e256c6605de7..012e589d90ce 100644
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
@@ -61,7 +61,7 @@ it is guaranteed that the state did change in between the two 
events.
 * - __u16
   - ``phys_addr``
   - The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
-  valid physical address is set.
+valid physical address is set.
 * - __u16
   - ``log_addr_mask``
   - The current set of claimed logical addresses. This is 0 if no logical
diff --git a/Documentation/media/uapi/cec/cec-ioc-receive.rst 
b/Documentation/media/uapi/cec/cec-ioc-receive.rst
index bdf015b1d1dc..3677fe6baf56 100644
--- a/Documentation/media/uapi/cec/cec-ioc-receive.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-receive.rst
@@ -56,13 +56,13 @@ A received message can be:
be non-zero).

 To send a CEC message the application has to fill in the struct
-:c:type:` cec_msg` and pass it to :ref:`ioctl CEC_TRANSMIT `.
+:c:type:`cec_msg` and pass it to :ref:`ioctl CEC_TRANSMIT `.
 The :ref:`ioctl CEC_TRANSMIT ` is only available if
 ``CEC_CAP_TRANSMIT`` is set. If there is no more room in the transmit
 queue, then it will return -1 and set errno to the ``EBUSY`` error code.
 The transmit queue has enough room for 18 messages (about 1 second worth
 of 2-byte messages). Note that the CEC kernel framework will also reply
-to core messages (see :ref:cec-core-processing), so it is not a good
+to core messages (see :ref:`cec-core-processing`), so it is not a good
 idea to fully fill up the transmit queue.

 If the file descriptor is in non-blocking mode then the transmit will