^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) # -*- coding: utf-8; mode: python -*-
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) # SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) project = 'Linux Media Subsystem Documentation'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) # It is possible to run Sphinx in nickpick mode with:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) nitpicky = True
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) # within nit-picking build, do not refer to any intersphinx object
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) intersphinx_mapping = {}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) # In nickpick mode, it will complain about lots of missing references that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) # 1) are just typedefs like: bool, __u32, etc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) # 2) It will complain for things like: enum, NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) # 3) It will complain for symbols that should be on different
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) # books (but currently aren't ported to ReST)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) # The list below has a list of such symbols to be ignored in nitpick mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) nitpick_ignore = [
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ("c:func", "clock_gettime"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) ("c:func", "close"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) ("c:func", "container_of"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) ("c:func", "copy_from_user"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) ("c:func", "copy_to_user"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) ("c:func", "determine_valid_ioctls"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) ("c:func", "ERR_PTR"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) ("c:func", "i2c_new_client_device"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) ("c:func", "ioctl"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) ("c:func", "IS_ERR"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) ("c:func", "KERNEL_VERSION"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) ("c:func", "mmap"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) ("c:func", "open"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) ("c:func", "pci_name"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) ("c:func", "poll"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) ("c:func", "PTR_ERR"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) ("c:func", "read"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) ("c:func", "release"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) ("c:func", "set"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) ("c:func", "struct fd_set"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) ("c:func", "struct pollfd"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) ("c:func", "usb_make_path"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) ("c:func", "wait_finish"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) ("c:func", "wait_prepare"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) ("c:func", "write"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) ("c:type", "atomic_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) ("c:type", "bool"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) ("c:type", "boolean"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) ("c:type", "buf_queue"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) ("c:type", "device"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) ("c:type", "device_driver"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) ("c:type", "device_node"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) ("c:type", "enum"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) ("c:type", "fd"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) ("c:type", "fd_set"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) ("c:type", "file"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) ("c:type", "i2c_adapter"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ("c:type", "i2c_board_info"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) ("c:type", "i2c_client"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) ("c:type", "int16_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) ("c:type", "ktime_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) ("c:type", "led_classdev_flash"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) ("c:type", "list_head"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) ("c:type", "lock_class_key"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) ("c:type", "module"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) ("c:type", "mutex"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) ("c:type", "NULL"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) ("c:type", "off_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) ("c:type", "pci_dev"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) ("c:type", "pdvbdev"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) ("c:type", "poll_table"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) ("c:type", "platform_device"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) ("c:type", "pollfd"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) ("c:type", "poll_table_struct"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) ("c:type", "s32"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) ("c:type", "s64"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) ("c:type", "sd"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) ("c:type", "size_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) ("c:type", "spi_board_info"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) ("c:type", "spi_device"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) ("c:type", "spi_master"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) ("c:type", "ssize_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) ("c:type", "fb_fix_screeninfo"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) ("c:type", "pollfd"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) ("c:type", "timeval"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) ("c:type", "video_capability"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) ("c:type", "timeval"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) ("c:type", "__u16"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) ("c:type", "u16"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) ("c:type", "__u32"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ("c:type", "u32"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) ("c:type", "__u64"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) ("c:type", "u64"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) ("c:type", "u8"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ("c:type", "uint16_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) ("c:type", "uint32_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) ("c:type", "union"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) ("c:type", "__user"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) ("c:type", "usb_device"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) ("c:type", "usb_interface"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) ("c:type", "v4l2_std_id"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) ("c:type", "video_system_t"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) ("c:type", "vm_area_struct"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) # Opaque structures
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) ("c:type", "v4l2_m2m_dev"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) ]