1 .. SPDX-License-Identifier: GPL-2.0 2 3 .. include:: ../disclaimer-zh_CN.rst 4 5 :Original: Documentation/doc-guide/parse-heade 6 7 :译者: å´æƒ³æˆ Wu XiangCheng <bobwxc@email. 8 9 ===================== 10 包å«ç”¨æˆ·ç©ºé—´API头文件 11 ===================== 12 13 有时,为了æ述用户空间API并在代ç 14 C代ç 。为用户空间APIæ–‡ä»¶æ·»åŠ äº¤å‰ 15 Sphinx将生æˆè¦å‘Šã€‚这有助于ä¿æŒç”¨æ 16 :ref:`parse_headers.pl <parse_headers_zh>` æ 17 在构建文档时,必须通过Makefileè°ƒç” 18 ``Documentation/userspace-api/media/Makefile`` 19 20 .. _parse_headers_zh: 21 22 parse_headers.pl 23 ---------------- 24 25 脚本å称 26 ~~~~~~~~ 27 28 29 parse_headers.pl——解æžä¸€ä¸ªCæ–‡ä»¶ï¼Œè¯ 30 创建交å‰å¼•ç”¨ã€‚ 31 32 33 ç”¨æ³•æ¦‚è¦ 34 ~~~~~~~~ 35 36 37 \ **parse_headers.pl**\ [<选项>] <C文件> 38 39 <选项> å¯ä»¥æ˜¯ï¼š --debug, --help 或 --us 40 41 42 选项 43 ~~~~ 44 45 46 47 \ **--debug**\ 48 49 å¼€å¯è„šæœ¬è¯¦ç»†æ¨¡å¼ï¼Œåœ¨è°ƒè¯•æ—¶å¾ˆæœ‰ 50 51 52 \ **--usage**\ 53 54 打å°ç®€çŸçš„帮助信æ¯å¹¶é€€å‡ºã€‚ 55 56 57 58 \ **--help**\ 59 60 打å°æ›´è¯¦ç»†çš„帮助信æ¯å¹¶é€€å‡ºã€‚ 61 62 63 说明 64 ~~~~ 65 66 通过C头文件或æºæ–‡ä»¶ï¼ˆ<C文件>ï¼‰ä¸ 67 文本 å—将文件转æ¢æˆé‡æž„文本(RST 68 å“ªäº›å…ƒç´ å°†è¢«å¿½ç•¥æˆ–æŒ‡å‘éžé»˜è®¤å¼•ç 69 70 输出被写入到<输出文件>。 71 72 它能够识别定义ã€å‡½æ•°ã€ç»“构体ã€t 73 它还能够区分用于指定Linux ioctlçš„ ` 74 75 <例外文件> 包å«ä¸¤ç§ç±»åž‹çš„è¯å¥ï¼š 76 77 ignoreæ ‡è®°çš„è¯æ³•ä¸ºï¼š 78 79 80 ignore \ **type**\ \ **name**\ 81 82 The \ **ignore**\ æ„味ç€å®ƒä¸ä¼šä¸ºç±»åž‹ 83 交å‰å¼•ç”¨ã€‚ 84 85 86 replaceæ ‡è®°çš„è¯æ³•ä¸ºï¼š 87 88 89 replace \ **type**\ \ **name**\ \ **new_valu 90 91 The \ **replace**\ 味ç€å®ƒå°†ä¸º \ **type** 92 用,但是它将使用 \ **new_value**\ æ¥å 93 94 95 这两ç§è¯å¥ä¸ï¼Œ \ **type**\ å¯ä»¥æ˜¯ä»¥ 96 97 98 \ **ioctl**\ 99 100 ignore 或 replace è¯å¥åº”用于ioctl定义 101 102 #define VIDIOC_DBG_S_REGISTER _IOW( 103 104 105 106 \ **define**\ 107 108 ignore 或 replace è¯å¥åº”用于在<C文件 109 110 111 112 \ **typedef**\ 113 114 ignore å’Œ replace è¯å¥åº”用于<C文件>ä¸ 115 116 117 118 \ **struct**\ 119 120 ignore å’Œ replace è¯å¥åº”用于<C文件>ä¸ 121 122 123 124 \ **enum**\ 125 126 ignore å’Œ replace è¯å¥åº”用于<C文件>ä¸ 127 128 129 130 \ **symbol**\ 131 132 ignore å’Œ replace è¯å¥åº”用于<C文件>ä¸ 133 134 replaceè¯å¥ä¸ï¼Œ \ **new_value**\ 会自å 135 å’Œ \ **struct**\ 类型的 :c:type: å¼•ç”¨ï¼ 136 \ **symbol**\ 类型的 :ref: ã€‚å¼•ç”¨çš„ç± 137 138 139 示例 140 ~~~~ 141 142 143 ignore define _VIDEODEV2_H 144 145 146 忽略<C文件>ä¸çš„ #define _VIDEODEV2_H 。 147 148 ignore symbol PRIVATE 149 150 151 如下结构体: 152 153 enum foo { BAR1, BAR2, PRIVATE }; 154 155 ä¸ä¼šä¸º \ **PRIVATE**\ 生æˆäº¤å‰å¼•ç”¨ã€‚ 156 157 replace symbol BAR1 :c:type:\`foo\` 158 replace symbol BAR2 :c:type:\`foo\` 159 160 161 如下结构体: 162 163 enum foo { BAR1, BAR2, PRIVATE }; 164 165 它会让BAR1å’ŒBAR2枚举符å·äº¤å‰å¼•ç”¨Cå 166 167 168 169 缺陷 170 ~~~~ 171 172 173 请å‘Mauro Carvalho Chehab <mchehab@kernel.org 174 175 ä¸æ–‡ç¿»è¯‘问题请找ä¸æ–‡ç¿»è¯‘维护者ã 176 177 178 ç‰ˆæƒ 179 ~~~~ 180 181 182 版æƒæ‰€æœ‰ (c) 2016 Mauro Carvalho Chehab <mc 183 184 许å¯è¯ GPLv2:GNU GPL version 2 <https://g 185 186 è¿™æ˜¯è‡ªç”±è½¯ä»¶ï¼šä½ å¯ä»¥è‡ªç”±åœ°ä¿®æ”¹å 187 在法律å…许的范围内,**ä¸æ供任ä½
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.