On 07/13/16 12:06, Mauro Carvalho Chehab wrote: > Hi Hans, > > Em Tue, 12 Jul 2016 20:07:45 +0200 > Hans Verkuil <hverkuil@xxxxxxxxx> escreveu: > >> From: Hans Verkuil <hans.verkuil@xxxxxxxxx> >> >> Lots of fixups relating to references. >> >> Signed-off-by: Hans Verkuil <hans.verkuil@xxxxxxxxx> >> --- >> Documentation/media/uapi/cec/cec-func-ioctl.rst | 2 +- >> Documentation/media/uapi/cec/cec-func-open.rst | 10 +++---- >> .../media/uapi/cec/cec-ioc-adap-g-caps.rst | 18 ++++++------ >> .../media/uapi/cec/cec-ioc-adap-g-log-addrs.rst | 14 ++++----- >> .../media/uapi/cec/cec-ioc-adap-g-phys-addr.rst | 14 ++++----- >> Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 2 +- >> Documentation/media/uapi/cec/cec-ioc-g-mode.rst | 34 +++++++++------------- >> Documentation/media/uapi/cec/cec-ioc-receive.rst | 28 +++++++++--------- >> 8 files changed, 58 insertions(+), 64 deletions(-) >> >> diff --git a/Documentation/media/uapi/cec/cec-func-ioctl.rst b/Documentation/media/uapi/cec/cec-func-ioctl.rst >> index a07cc7c..d0279e6d 100644 >> --- a/Documentation/media/uapi/cec/cec-func-ioctl.rst >> +++ b/Documentation/media/uapi/cec/cec-func-ioctl.rst >> @@ -29,7 +29,7 @@ Arguments >> >> ``request`` >> CEC ioctl request code as defined in the cec.h header file, for >> - example 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 245d679..cbf1176 100644 >> --- a/Documentation/media/uapi/cec/cec-func-open.rst >> +++ b/Documentation/media/uapi/cec/cec-func-open.rst >> @@ -32,11 +32,11 @@ Arguments >> Open flags. Access mode must be ``O_RDWR``. >> >> When the ``O_NONBLOCK`` flag is given, the >> - :ref:`CEC_RECEIVE` ioctl will return EAGAIN >> - error code when no message is available, and the >> - :ref:`CEC_TRANSMIT`, >> - :ref:`CEC_ADAP_S_PHYS_ADDR` and >> - :ref:`CEC_ADAP_S_LOG_ADDRS` ioctls >> + :ref:`CEC_RECEIVE <CEC_RECEIVE>` ioctl will return the EAGAIN >> + error code when no message is available, and ioctls >> + :ref:`CEC_TRANSMIT <CEC_TRANSMIT>`, >> + :ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>` and >> + :ref:`CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` >> all act in non-blocking mode. >> >> Other flags have no effect. >> 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 2ca9199..63b808e 100644 >> --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst >> +++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst >> @@ -34,7 +34,7 @@ Description >> .. note:: This documents the proposed CEC API. This API is not yet finalized >> and is currently only available as a staging kernel module. >> >> -All cec devices must support the :ref:`CEC_ADAP_G_CAPS` ioctl. To query >> +All cec devices must support ``CEC_ADAP_G_CAPS``. To query > > Why are you removing the ref here and on other similar places? If you > remove it, the font and font color for it will be different and > inconsistent. It will also be inconsistent with the other places > within the document, were it is using a reference everywhere. What's the point of having a link to the same page that you are watching? I also found it very cumbersome and ugly having to write e.g. :ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR> all the time. That is fine if it actually points to another page (it serves a real purpose then), but on the page itself I think it is ugly. We never did that with the DocBook documentation either. Regards, Hans -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
