About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / media / conf_nitpick.py




Custom Search

Based on kernel version 4.16.1. Page generated on 2018-04-09 11:53 EST.

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", "copy_from_user"),
25	    ("c:func", "copy_to_user"),
26	    ("c:func", "determine_valid_ioctls"),
27	    ("c:func", "ERR_PTR"),
28	    ("c:func", "i2c_new_device"),
29	    ("c:func", "ioctl"),
30	    ("c:func", "IS_ERR"),
31	    ("c:func", "KERNEL_VERSION"),
32	    ("c:func", "mmap"),
33	    ("c:func", "open"),
34	    ("c:func", "pci_name"),
35	    ("c:func", "poll"),
36	    ("c:func", "PTR_ERR"),
37	    ("c:func", "read"),
38	    ("c:func", "release"),
39	    ("c:func", "set"),
40	    ("c:func", "struct fd_set"),
41	    ("c:func", "struct pollfd"),
42	    ("c:func", "usb_make_path"),
43	    ("c:func", "wait_finish"),
44	    ("c:func", "wait_prepare"),
45	    ("c:func", "write"),
46	
47	    ("c:type", "atomic_t"),
48	    ("c:type", "bool"),
49	    ("c:type", "boolean"),
50	    ("c:type", "buf_queue"),
51	    ("c:type", "device"),
52	    ("c:type", "device_driver"),
53	    ("c:type", "device_node"),
54	    ("c:type", "enum"),
55	    ("c:type", "fd"),
56	    ("c:type", "fd_set"),
57	    ("c:type", "file"),
58	    ("c:type", "i2c_adapter"),
59	    ("c:type", "i2c_board_info"),
60	    ("c:type", "i2c_client"),
61	    ("c:type", "int16_t"),
62	    ("c:type", "ktime_t"),
63	    ("c:type", "led_classdev_flash"),
64	    ("c:type", "list_head"),
65	    ("c:type", "lock_class_key"),
66	    ("c:type", "module"),
67	    ("c:type", "mutex"),
68	    ("c:type", "NULL"),
69	    ("c:type", "off_t"),
70	    ("c:type", "pci_dev"),
71	    ("c:type", "pdvbdev"),
72	    ("c:type", "poll_table"),
73	    ("c:type", "platform_device"),
74	    ("c:type", "pollfd"),
75	    ("c:type", "poll_table_struct"),
76	    ("c:type", "s32"),
77	    ("c:type", "s64"),
78	    ("c:type", "sd"),
79	    ("c:type", "size_t"),
80	    ("c:type", "spi_board_info"),
81	    ("c:type", "spi_device"),
82	    ("c:type", "spi_master"),
83	    ("c:type", "ssize_t"),
84	    ("c:type", "fb_fix_screeninfo"),
85	    ("c:type", "pollfd"),
86	    ("c:type", "timeval"),
87	    ("c:type", "video_capability"),
88	    ("c:type", "timeval"),
89	    ("c:type", "__u16"),
90	    ("c:type", "u16"),
91	    ("c:type", "__u32"),
92	    ("c:type", "u32"),
93	    ("c:type", "__u64"),
94	    ("c:type", "u64"),
95	    ("c:type", "u8"),
96	    ("c:type", "uint16_t"),
97	    ("c:type", "uint32_t"),
98	    ("c:type", "union"),
99	    ("c:type", "__user"),
100	    ("c:type", "usb_device"),
101	    ("c:type", "usb_interface"),
102	    ("c:type", "v4l2_std_id"),
103	    ("c:type", "video_system_t"),
104	    ("c:type", "vm_area_struct"),
105	
106	    # Opaque structures
107	
108	    ("c:type", "v4l2_m2m_dev"),
109	]
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.