Documentation/media/conf_nitpick.py

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