userspace-api/media/conf_nitpick.py

0001 # -*- coding: utf-8; mode: python -*-
0002
0003 # SPDX-License-Identifier: GPL-2.0
0004
0005 project = 'Linux Media Subsystem Documentation'
0006
0007 # It is possible to run Sphinx in nickpick mode with:
0008 nitpicky = True
0009
0010 # within nit-picking build, do not refer to any intersphinx object
0011 intersphinx_mapping = {}
0012
0013 # In nickpick mode, it will complain about lots of missing references that
0014 #
0015 # 1) are just typedefs like: bool, __u32, etc;
0016 # 2) It will complain for things like: enum, NULL;
0017 # 3) It will complain for symbols that should be on different
0018 #    books (but currently aren't ported to ReST)
0019 #
0020 # The list below has a list of such symbols to be ignored in nitpick mode
0021 #
0022 nitpick_ignore = [
0023     ("c:func", "clock_gettime"),
0024     ("c:func", "close"),
0025     ("c:func", "container_of"),
0026     ("c:func", "copy_from_user"),
0027     ("c:func", "copy_to_user"),
0028     ("c:func", "determine_valid_ioctls"),
0029     ("c:func", "ERR_PTR"),
0030     ("c:func", "i2c_new_client_device"),
0031     ("c:func", "ioctl"),
0032     ("c:func", "IS_ERR"),
0033     ("c:func", "KERNEL_VERSION"),
0034     ("c:func", "mmap"),
0035     ("c:func", "open"),
0036     ("c:func", "pci_name"),
0037     ("c:func", "poll"),
0038     ("c:func", "PTR_ERR"),
0039     ("c:func", "read"),
0040     ("c:func", "release"),
0041     ("c:func", "set"),
0042     ("c:func", "struct fd_set"),
0043     ("c:func", "struct pollfd"),
0044     ("c:func", "usb_make_path"),
0045     ("c:func", "wait_finish"),
0046     ("c:func", "wait_prepare"),
0047     ("c:func", "write"),
0048
0049     ("c:type", "atomic_t"),
0050     ("c:type", "bool"),
0051     ("c:type", "boolean"),
0052     ("c:type", "buf_queue"),
0053     ("c:type", "device"),
0054     ("c:type", "device_driver"),
0055     ("c:type", "device_node"),
0056     ("c:type", "enum"),
0057     ("c:type", "fd"),
0058     ("c:type", "fd_set"),
0059     ("c:type", "file"),
0060     ("c:type", "i2c_adapter"),
0061     ("c:type", "i2c_board_info"),
0062     ("c:type", "i2c_client"),
0063     ("c:type", "int16_t"),
0064     ("c:type", "ktime_t"),
0065     ("c:type", "led_classdev_flash"),
0066     ("c:type", "list_head"),
0067     ("c:type", "lock_class_key"),
0068     ("c:type", "module"),
0069     ("c:type", "mutex"),
0070     ("c:type", "NULL"),
0071     ("c:type", "off_t"),
0072     ("c:type", "pci_dev"),
0073     ("c:type", "pdvbdev"),
0074     ("c:type", "poll_table"),
0075     ("c:type", "platform_device"),
0076     ("c:type", "pollfd"),
0077     ("c:type", "poll_table_struct"),
0078     ("c:type", "s32"),
0079     ("c:type", "s64"),
0080     ("c:type", "sd"),
0081     ("c:type", "size_t"),
0082     ("c:type", "spi_board_info"),
0083     ("c:type", "spi_device"),
0084     ("c:type", "spi_master"),
0085     ("c:type", "ssize_t"),
0086     ("c:type", "fb_fix_screeninfo"),
0087     ("c:type", "pollfd"),
0088     ("c:type", "timeval"),
0089     ("c:type", "video_capability"),
0090     ("c:type", "timeval"),
0091     ("c:type", "__u16"),
0092     ("c:type", "u16"),
0093     ("c:type", "__u32"),
0094     ("c:type", "u32"),
0095     ("c:type", "__u64"),
0096     ("c:type", "u64"),
0097     ("c:type", "u8"),
0098     ("c:type", "uint16_t"),
0099     ("c:type", "uint32_t"),
0100     ("c:type", "union"),
0101     ("c:type", "__user"),
0102     ("c:type", "usb_device"),
0103     ("c:type", "usb_interface"),
0104     ("c:type", "v4l2_std_id"),
0105     ("c:type", "video_system_t"),
0106     ("c:type", "vm_area_struct"),
0107
0108     # Opaque structures
0109
0110     ("c:type", "v4l2_m2m_dev"),
0111 ]