Documentation/media/conf_nitpick.py

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