Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e8be7e97 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-rst: convert uAPI structs to C domain 



instead of declaring the uAPI structs using usual refs, e. g.:
	.. _foo-struct:

Use the C domain way:
	.. c:type:: foo_struct

This way, the kAPI documentation can use cross-references to
point to the uAPI symbols.

That solves about ~100 undefined warnings like:
	WARNING: c:type reference target not found: foo_struct

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 2257e180

Documentation/media/kapi/v4l2-event.rst

+3 −3
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ A good example of these ``replace``/``merge`` callbacks is in v4l2-event.c: 
In order to queue events to video device, drivers should call:



	:c:func:`v4l2_event_queue <v4l2_event_queue>`

	(:c:type:`vdev <video_device>`, :ref:`ev <v4l2-event>`)

	(:c:type:`vdev <video_device>`, :c:type:`ev <v4l2_event>`)



The driver's only responsibility is to fill in the type and the data fields.

The other fields will be filled in by V4L2.
@@ -51,7 +51,7 @@ Event subscription 
Subscribing to an event is via:



	:c:func:`v4l2_event_subscribe <v4l2_event_subscribe>`

	(:c:type:`fh <v4l2_fh>`, :ref:`sub <v4l2-event-subscription>` ,

	(:c:type:`fh <v4l2_fh>`, :c:type:`sub <v4l2_event_subscription>` ,

	elems, :c:type:`ops <v4l2_subscribed_event_ops>`)
@@ -86,7 +86,7 @@ Unsubscribing an event 
Unsubscribing to an event is via:



	:c:func:`v4l2_event_unsubscribe <v4l2_event_unsubscribe>`

	(:c:type:`fh <v4l2_fh>`, :ref:`sub <v4l2-event-subscription>`)

	(:c:type:`fh <v4l2_fh>`, :c:type:`sub <v4l2_event_subscription>`)



This function is used to implement :c:type:`video_device`->

:c:type:`ioctl_ops <v4l2_ioctl_ops>`-> ``vidioc_unsubscribe_event``.

Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst

+2 −2
Original line number Diff line number Diff line
@@ -36,12 +36,12 @@ Description 


All cec devices must support :ref:`ioctl CEC_ADAP_G_CAPS <CEC_ADAP_G_CAPS>`. To query

device information, applications call the ioctl with a pointer to a

struct :ref:`cec_caps <cec-caps>`. The driver fills the structure and

struct :c:type:`cec_caps`. The driver fills the structure and

returns the information to the application. The ioctl never fails.



.. tabularcolumns:: |p{1.2cm}|p{2.5cm}|p{13.8cm}|



.. _cec-caps:

.. c:type:: cec_caps



.. flat-table:: struct cec_caps

    :header-rows:  0

Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ logical address types are already defined will return with error ``EBUSY``. 


.. tabularcolumns:: |p{1.0cm}|p{7.5cm}|p{8.0cm}|



.. _cec-log-addrs:

.. c:type:: cec_log_addrs



.. cssclass:: longtable

Documentation/media/uapi/cec/cec-ioc-dqevent.rst

+1 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ it is guaranteed that the state did change in between the two events. 


.. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{2.5cm}|p{8.8cm}|



.. _cec-event:

.. c:type:: cec_event



.. flat-table:: struct cec_event

    :header-rows:  0

Documentation/media/uapi/cec/cec-ioc-receive.rst

+1 −1
Original line number Diff line number Diff line
@@ -76,7 +76,7 @@ result. 


.. tabularcolumns:: |p{1.0cm}|p{3.5cm}|p{13.0cm}|



.. _cec-msg:

.. c:type:: cec_msg



.. cssclass:: longtable