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

Commit 1b81f010 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-next: stop abusing on the cpp domain 



Now that we have an override for the c domain that will do
the right thing for the Kernel, stop abusing on the cpp
domain.

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

Documentation/media/conf_nitpick.py

+16 −17
Original line number Diff line number Diff line
@@ -39,55 +39,54 @@ nitpick_ignore = [ 
    ("c:func", "write"),

    ("c:type", "atomic_t"),

    ("c:type", "bool"),

    ("c:type", "boolean"),

    ("c:type", "buf_queue"),

    ("c:type", "device"),

    ("c:type", "device_driver"),

    ("c:type", "device_node"),

    ("c:type", "enum"),

    ("c:type", "fd"),

    ("c:type", "fd_set"),

    ("c:type", "file"),

    ("c:type", "i2c_adapter"),

    ("c:type", "i2c_board_info"),

    ("c:type", "i2c_client"),

    ("c:type", "int16_t"),

    ("c:type", "ktime_t"),

    ("c:type", "led_classdev_flash"),

    ("c:type", "list_head"),

    ("c:type", "lock_class_key"),

    ("c:type", "module"),

    ("c:type", "mutex"),

    ("c:type", "NULL"),

    ("c:type", "off_t"),

    ("c:type", "pci_dev"),

    ("c:type", "pdvbdev"),

    ("c:type", "pollfd"),

    ("c:type", "poll_table_struct"),

    ("c:type", "s32"),

    ("c:type", "s64"),

    ("c:type", "sd"),

    ("c:type", "size_t"),

    ("c:type", "spi_board_info"),

    ("c:type", "spi_device"),

    ("c:type", "spi_master"),

    ("c:type", "ssize_t"),

    ("c:type", "struct fb_fix_screeninfo"),

    ("c:type", "struct pollfd"),

    ("c:type", "struct timeval"),

    ("c:type", "struct video_capability"),

    ("c:type", "timeval"),

    ("c:type", "__u16"),

    ("c:type", "u16"),

    ("c:type", "__u32"),

    ("c:type", "u32"),

    ("c:type", "__u64"),

    ("c:type", "u64"),

    ("c:type", "u8"),

    ("c:type", "uint16_t"),

    ("c:type", "uint32_t"),

    ("c:type", "union"),

    ("c:type", "usb_device"),



    ("cpp:type", "boolean"),

    ("cpp:type", "fd"),

    ("cpp:type", "fd_set"),

    ("cpp:type", "int16_t"),

    ("cpp:type", "NULL"),

    ("cpp:type", "off_t"),

    ("cpp:type", "pollfd"),

    ("cpp:type", "size_t"),

    ("cpp:type", "ssize_t"),

    ("cpp:type", "timeval"),

    ("cpp:type", "__u16"),

    ("cpp:type", "__u32"),

    ("cpp:type", "__u64"),

    ("cpp:type", "uint16_t"),

    ("cpp:type", "uint32_t"),

    ("cpp:type", "video_system_t"),

    ("c:type", "video_system_t"),

]

Documentation/media/kapi/dtv-core.rst

+1 −1
Original line number Diff line number Diff line
@@ -121,7 +121,7 @@ triggered by a hardware interrupt, it is recommended to use the Linux 
bottom half mechanism or start a tasklet instead of making the callback

function call directly from a hardware interrupt.



This mechanism is implemented by :c:func:`dmx_ts_cb()` and :cpp:func:`dmx_section_cb()`

This mechanism is implemented by :c:func:`dmx_ts_cb()` and :c:func:`dmx_section_cb()`

callbacks.



.. kernel-doc:: drivers/media/dvb-core/demux.h

Documentation/media/kapi/v4l2-dev.rst

+2 −2
Original line number Diff line number Diff line
@@ -166,7 +166,7 @@ something. 
In the case of :ref:`videobuf2 <vb2_framework>` you will need to implement the

``wait_prepare()`` and ``wait_finish()`` callbacks to unlock/lock if applicable.

If you use the ``queue->lock`` pointer, then you can use the helper functions

:c:func:`vb2_ops_wait_prepare` and :cpp:func:`vb2_ops_wait_finish`.

:c:func:`vb2_ops_wait_prepare` and :c:func:`vb2_ops_wait_finish`.



The implementation of a hotplug disconnect should also take the lock from

:c:type:`video_device` before calling v4l2_device_disconnect. If you are also
@@ -335,7 +335,7 @@ And this function: 


returns the video_device belonging to the file struct.



The :c:func:`video_devdata` function combines :cpp:func:`video_get_drvdata`

The :c:func:`video_devdata` function combines :c:func:`video_get_drvdata`

with :c:func:`video_devdata`:



	:c:func:`video_drvdata <video_drvdata>`

Documentation/media/kapi/v4l2-fh.rst

+2 −2
Original line number Diff line number Diff line
@@ -21,8 +21,8 @@ function by the driver. 
In many cases the struct :c:type:`v4l2_fh` will be embedded in a larger

structure. In that case you should call:



#) :c:func:`v4l2_fh_init` and :cpp:func:`v4l2_fh_add` in ``open()``

#) :c:func:`v4l2_fh_del` and :cpp:func:`v4l2_fh_exit` in ``release()``

#) :c:func:`v4l2_fh_init` and :c:func:`v4l2_fh_add` in ``open()``

#) :c:func:`v4l2_fh_del` and :c:func:`v4l2_fh_exit` in ``release()``



Drivers can extract their own file handle structure by using the container_of

macro.

Documentation/media/kapi/v4l2-subdev.rst

+1 −1
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ methods. 
Bridges might also need to store per-subdev private data, such as a pointer to

bridge-specific per-subdev private data. The :c:type:`v4l2_subdev` structure

provides host private data for that purpose that can be accessed with

:c:func:`v4l2_get_subdev_hostdata` and :cpp:func:`v4l2_set_subdev_hostdata`.

:c:func:`v4l2_get_subdev_hostdata` and :c:func:`v4l2_set_subdev_hostdata`.



From the bridge driver perspective, you load the sub-device module and somehow

obtain the :c:type:`v4l2_subdev` pointer. For i2c devices this is easy: you call