13a591515SWu XiangCheng.. include:: ../disclaimer-zh_CN.rst 23a591515SWu XiangCheng 33a591515SWu XiangCheng:Original: Documentation/doc-guide/kernel-doc.rst 43a591515SWu XiangCheng 53a591515SWu XiangCheng:译者: 吴想成 Wu XiangCheng <bobwxc@email.cn> 63a591515SWu XiangCheng 73a591515SWu XiangCheng编写kernel-doc注释 83a591515SWu XiangCheng================== 93a591515SWu XiangCheng 103a591515SWu XiangChengLinux内核源文件可以包含kernel-doc格式的结构化文档注释,用以描述代码的函数、 113a591515SWu XiangCheng类型和设计。将文档嵌入源文件更容易保持文档最新。 123a591515SWu XiangCheng 133a591515SWu XiangCheng.. note:: 内核文档格式与javadoc、gtk-doc或Doxygen看似很相似,但由于历史原因, 143a591515SWu XiangCheng 实际有着明显的不同。内核源包含成千上万个kernel-doc注释。请坚持遵循 153a591515SWu XiangCheng 此处描述的风格。 163a591515SWu XiangCheng 17*695c62a8SMauro Carvalho Chehab.. note:: kernel-doc无法包含Rust代码:请参考 Documentation/rust/general-information.rst 。 183a591515SWu XiangCheng 193a591515SWu XiangCheng从注释中提取kernel-doc结构,并从中生成适当的 `Sphinx C 域`_ 函数和带有锚点的 203a591515SWu XiangCheng类型描述。这些注释将被过滤以生成特殊kernel-doc高亮和交叉引用。详见下文。 213a591515SWu XiangCheng 223a591515SWu XiangCheng.. _Sphinx C 域: http://www.sphinx-doc.org/en/stable/domains.html 233a591515SWu XiangCheng 243a591515SWu XiangCheng使用 ``EXPORT_SYMBOL`` 或 ``EXPORT_SYMBOL_GPL`` 导出到可加载模块的每个函数都 253a591515SWu XiangCheng应该有一个kernel-doc注释。模块使用的头文件中的函数和数据结构也应该有 263a591515SWu XiangChengkernel-doc注释。 273a591515SWu XiangCheng 283a591515SWu XiangCheng对于其他内核文件(未标记为 ``static`` )中外部可见的函数,提供kernel-doc格式 293a591515SWu XiangCheng的文档是一个很好的实践。我们也建议为私有(文件 ``static`` )程序提供kernel-doc 303a591515SWu XiangCheng格式的文档,以确保内核源代码布局的一致性。此建议优先级较低,由内核源文件的 313a591515SWu XiangCheng维护者自行决定。 323a591515SWu XiangCheng 333a591515SWu XiangCheng如何格式化kernel-doc注释 343a591515SWu XiangCheng------------------------ 353a591515SWu XiangCheng 363a591515SWu XiangChengkernel-doc注释用 ``/**`` 作为开始标记。 ``kernel-doc`` 工具将提取以这种方式 373a591515SWu XiangCheng标记的注释。注释其余部分的格式类似于一个普通的多行注释,左侧有一列星号,以 383a591515SWu XiangCheng``*/`` 行结束。 393a591515SWu XiangCheng 403a591515SWu XiangCheng函数和类型的kernel-doc注释应该放在所描述的函数或类型之前,以便最大限度地提高 413a591515SWu XiangCheng更改代码的人同时更改文档的可能性。概述kernel-doc注释可以放在最顶部的任何地方。 423a591515SWu XiangCheng 433a591515SWu XiangCheng用详细模式和不生成实际输出来运行 ``kernel-doc`` 工具,可以验证文档注释的格式 443a591515SWu XiangCheng是否正确。例如:: 453a591515SWu XiangCheng 463a591515SWu XiangCheng scripts/kernel-doc -v -none drivers/foo/bar.c 473a591515SWu XiangCheng 483a591515SWu XiangCheng当请求执行额外的gcc检查时,内核构建将验证文档格式:: 493a591515SWu XiangCheng 503a591515SWu XiangCheng make W=n 513a591515SWu XiangCheng 523a591515SWu XiangCheng函数文档 533a591515SWu XiangCheng-------- 543a591515SWu XiangCheng 553a591515SWu XiangCheng函数和函数式宏的kernel-doc注释的一般格式是:: 563a591515SWu XiangCheng 573a591515SWu XiangCheng /** 583a591515SWu XiangCheng * 函数名() - 函数简要说明. 593a591515SWu XiangCheng * @参数1: 描述第一个参数. 603a591515SWu XiangCheng * @参数2: 描述第二个参数. 613a591515SWu XiangCheng * 可以为参数提供一段 623a591515SWu XiangCheng * 多行描述. 633a591515SWu XiangCheng * 643a591515SWu XiangCheng * 更详细的描述,进一步讨论函数 函数名(), 这可能对使用或修改它的人有用. 653a591515SWu XiangCheng * 以空注释行开始, 内部可以包含空注释行. 663a591515SWu XiangCheng * 673a591515SWu XiangCheng * 详细描述可以有多个段落. 683a591515SWu XiangCheng * 693a591515SWu XiangCheng * Context: 描述函数是否可以休眠, 它需要、释放或期望持有什么锁. 703a591515SWu XiangCheng * 可以写多行. 713a591515SWu XiangCheng * Return: 描述函数返回值. 723a591515SWu XiangCheng * 733a591515SWu XiangCheng * 返回值描述也可以有多个段落, 743a591515SWu XiangCheng * 并且应该放在注释块的末尾. 753a591515SWu XiangCheng */ 763a591515SWu XiangCheng 773a591515SWu XiangCheng函数名后面的简短描述可以跨多行,并以参数描述、空注释行或注释块结尾结束。 783a591515SWu XiangCheng 793a591515SWu XiangCheng函数参数 803a591515SWu XiangCheng~~~~~~~~ 813a591515SWu XiangCheng 823a591515SWu XiangCheng每个函数参数都应该按照顺序描述,紧跟在函数简要说明之后。不要在函数描述和参数 833a591515SWu XiangCheng之间,也不要在参数之间留空。 843a591515SWu XiangCheng 853a591515SWu XiangCheng每个 ``@参数:`` 描述可以跨多行。 863a591515SWu XiangCheng 873a591515SWu XiangCheng.. note:: 883a591515SWu XiangCheng 893a591515SWu XiangCheng 如果 ``@参数`` 描述有多行,则说明的续行应该从上一行的同一列开始:: 903a591515SWu XiangCheng 913a591515SWu XiangCheng * @参数: 较长说明 923a591515SWu XiangCheng * 的续行 933a591515SWu XiangCheng 943a591515SWu XiangCheng 或:: 953a591515SWu XiangCheng 963a591515SWu XiangCheng * @参数: 973a591515SWu XiangCheng * 较长说明 983a591515SWu XiangCheng * 的续行 993a591515SWu XiangCheng 1003a591515SWu XiangCheng如果函数的参数数目可变,则需用kernel-doc格式对其进行描述:: 1013a591515SWu XiangCheng 1023a591515SWu XiangCheng * @...: 描述 1033a591515SWu XiangCheng 1043a591515SWu XiangCheng函数上下文 1053a591515SWu XiangCheng~~~~~~~~~~ 1063a591515SWu XiangCheng 1073a591515SWu XiangCheng可调用函数的上下文应该在 ``Context`` 节中描述。此节应该包括函数是休眠的还是 1083a591515SWu XiangCheng可以从中断上下文调用的,以及它需要什么锁、释放什么锁和期望它的调用者持有什么 1093a591515SWu XiangCheng锁。 1103a591515SWu XiangCheng 1113a591515SWu XiangCheng例如:: 1123a591515SWu XiangCheng 1133a591515SWu XiangCheng * Context: Any context. 1143a591515SWu XiangCheng * Context: Any context. Takes and releases the RCU lock. 1153a591515SWu XiangCheng * Context: Any context. Expects <lock> to be held by caller. 1163a591515SWu XiangCheng * Context: Process context. May sleep if @gfp flags permit. 1173a591515SWu XiangCheng * Context: Process context. Takes and releases <mutex>. 1183a591515SWu XiangCheng * Context: Softirq or process context. Takes and releases <lock>, BH-safe. 1193a591515SWu XiangCheng * Context: Interrupt context. 1203a591515SWu XiangCheng 1213a591515SWu XiangCheng返回值 1223a591515SWu XiangCheng~~~~~~ 1233a591515SWu XiangCheng 1243a591515SWu XiangCheng如有返回值,应在 ``Return`` 节中描述。 1253a591515SWu XiangCheng 1263a591515SWu XiangCheng.. note:: 1273a591515SWu XiangCheng 1283a591515SWu XiangCheng #) 您提供的多行描述文本 *不会* 识别换行符,因此如果您想将某些文本预格式化, 1293a591515SWu XiangCheng 如:: 1303a591515SWu XiangCheng 1313a591515SWu XiangCheng * Return: 1323a591515SWu XiangCheng * 0 - OK 1333a591515SWu XiangCheng * -EINVAL - invalid argument 1343a591515SWu XiangCheng * -ENOMEM - out of memory 1353a591515SWu XiangCheng 1363a591515SWu XiangCheng 它们在最终文档中变成一行:: 1373a591515SWu XiangCheng 1383a591515SWu XiangCheng Return: 0 - OK -EINVAL - invalid argument -ENOMEM - out of memory 1393a591515SWu XiangCheng 1403a591515SWu XiangCheng 因此,为了在需要的地方换行,您需要使用ReST列表,例如:: 1413a591515SWu XiangCheng 1423a591515SWu XiangCheng * Return: 1433a591515SWu XiangCheng * * 0 - OK to runtime suspend the device 1443a591515SWu XiangCheng * * -EBUSY - Device should not be runtime suspended 1453a591515SWu XiangCheng 1463a591515SWu XiangCheng #) 如果您提供的描述性文本中的行以某个后跟冒号的短语开头,则每一个这种短语 1473a591515SWu XiangCheng 都将被视为新的节标题,可能会产生意料不到的效果。 1483a591515SWu XiangCheng 1493a591515SWu XiangCheng结构体、共用体、枚举类型文档 1503a591515SWu XiangCheng---------------------------- 1513a591515SWu XiangCheng 1523a591515SWu XiangCheng结构体(struct)、共用体(union)、枚举(enum)类型kernel-doc注释的一般格式为:: 1533a591515SWu XiangCheng 1543a591515SWu XiangCheng /** 1553a591515SWu XiangCheng * struct 结构体名 - 简要描述. 1563a591515SWu XiangCheng * @成员1: 成员1描述. 1573a591515SWu XiangCheng * @成员2: 成员2描述. 1583a591515SWu XiangCheng * 可以为成员提供 1593a591515SWu XiangCheng * 多行描述. 1603a591515SWu XiangCheng * 1613a591515SWu XiangCheng * 结构体的描述. 1623a591515SWu XiangCheng */ 1633a591515SWu XiangCheng 1643a591515SWu XiangCheng可以用 ``union`` 或 ``enum`` 替换上面示例中的 ``struct`` ,以描述共用体或枚举。 1653a591515SWu XiangCheng``成员`` 用于表示枚举中的元素或共用体成员。 1663a591515SWu XiangCheng 1673a591515SWu XiangCheng结构体名称后面的简要说明可以跨多行,并以成员说明、空白注释行或注释块结尾结束。 1683a591515SWu XiangCheng 1693a591515SWu XiangCheng成员 1703a591515SWu XiangCheng~~~~ 1713a591515SWu XiangCheng 1723a591515SWu XiangCheng结构体、共用体和枚举的成员应以与函数参数相同的方式记录;它们后紧跟简短的描述, 1733a591515SWu XiangCheng并且为多行。 1743a591515SWu XiangCheng 1753a591515SWu XiangCheng在结构体或共用体描述中,可以使用 ``private:`` 和 ``public:`` 注释标签。 1763a591515SWu XiangCheng``private:`` 域内的字段不会列在生成的文档中。 1773a591515SWu XiangCheng 1783a591515SWu XiangCheng``private:`` 和 ``public:`` 标签必须紧跟在 ``/*`` 注释标记之后。可以选择是否 1793a591515SWu XiangCheng在 ``:`` 和 ``*/`` 结束标记之间包含注释。 1803a591515SWu XiangCheng 1813a591515SWu XiangCheng例子:: 1823a591515SWu XiangCheng 1833a591515SWu XiangCheng /** 1843a591515SWu XiangCheng * struct 张三 - 简短描述 1853a591515SWu XiangCheng * @a: 第一个成员 1863a591515SWu XiangCheng * @b: 第二个成员 1873a591515SWu XiangCheng * @d: 第三个成员 1883a591515SWu XiangCheng * 1893a591515SWu XiangCheng * 详细描述 1903a591515SWu XiangCheng */ 1913a591515SWu XiangCheng struct 张三 { 1923a591515SWu XiangCheng int a; 1933a591515SWu XiangCheng int b; 1943a591515SWu XiangCheng /* private: 仅内部使用 */ 1953a591515SWu XiangCheng int c; 1963a591515SWu XiangCheng /* public: 下一个是公有的 */ 1973a591515SWu XiangCheng int d; 1983a591515SWu XiangCheng }; 1993a591515SWu XiangCheng 2003a591515SWu XiangCheng嵌套的结构体/共用体 2013a591515SWu XiangCheng~~~~~~~~~~~~~~~~~~~ 2023a591515SWu XiangCheng 2033a591515SWu XiangCheng嵌套的结构体/共用体可像这样记录:: 2043a591515SWu XiangCheng 2053a591515SWu XiangCheng /** 2063a591515SWu XiangCheng * struct nested_foobar - a struct with nested unions and structs 2073a591515SWu XiangCheng * @memb1: first member of anonymous union/anonymous struct 2083a591515SWu XiangCheng * @memb2: second member of anonymous union/anonymous struct 2093a591515SWu XiangCheng * @memb3: third member of anonymous union/anonymous struct 2103a591515SWu XiangCheng * @memb4: fourth member of anonymous union/anonymous struct 2113a591515SWu XiangCheng * @bar: non-anonymous union 2123a591515SWu XiangCheng * @bar.st1: struct st1 inside @bar 2133a591515SWu XiangCheng * @bar.st2: struct st2 inside @bar 2143a591515SWu XiangCheng * @bar.st1.memb1: first member of struct st1 on union bar 2153a591515SWu XiangCheng * @bar.st1.memb2: second member of struct st1 on union bar 2163a591515SWu XiangCheng * @bar.st2.memb1: first member of struct st2 on union bar 2173a591515SWu XiangCheng * @bar.st2.memb2: second member of struct st2 on union bar 2183a591515SWu XiangCheng */ 2193a591515SWu XiangCheng struct nested_foobar { 2203a591515SWu XiangCheng /* Anonymous union/struct*/ 2213a591515SWu XiangCheng union { 2223a591515SWu XiangCheng struct { 2233a591515SWu XiangCheng int memb1; 2243a591515SWu XiangCheng int memb2; 2253a591515SWu XiangCheng }; 2263a591515SWu XiangCheng struct { 2273a591515SWu XiangCheng void *memb3; 2283a591515SWu XiangCheng int memb4; 2293a591515SWu XiangCheng }; 2303a591515SWu XiangCheng }; 2313a591515SWu XiangCheng union { 2323a591515SWu XiangCheng struct { 2333a591515SWu XiangCheng int memb1; 2343a591515SWu XiangCheng int memb2; 2353a591515SWu XiangCheng } st1; 2363a591515SWu XiangCheng struct { 2373a591515SWu XiangCheng void *memb1; 2383a591515SWu XiangCheng int memb2; 2393a591515SWu XiangCheng } st2; 2403a591515SWu XiangCheng } bar; 2413a591515SWu XiangCheng }; 2423a591515SWu XiangCheng 2433a591515SWu XiangCheng.. note:: 2443a591515SWu XiangCheng 2453a591515SWu XiangCheng #) 在记录嵌套结构体或共用体时,如果结构体/共用体 ``张三`` 已命名,则其中 2463a591515SWu XiangCheng 的成员 ``李四`` 应记录为 ``@张三.李四:`` 2473a591515SWu XiangCheng 2483a591515SWu XiangCheng #) 当嵌套结构体/共用体是匿名的时,其中的成员 ``李四`` 应记录为 ``@李四:`` 2493a591515SWu XiangCheng 2503a591515SWu XiangCheng行间注释文档 2513a591515SWu XiangCheng~~~~~~~~~~~~ 2523a591515SWu XiangCheng 2533a591515SWu XiangCheng结构成员也可在定义时以行间注释形式记录。有两种样式,一种是单行注释,其中开始 2543a591515SWu XiangCheng``/**`` 和结束 ``*/`` 位于同一行;另一种是多行注释,开头结尾各自位于一行,就 2553a591515SWu XiangCheng像所有其他核心文档注释一样:: 2563a591515SWu XiangCheng 2573a591515SWu XiangCheng /** 2583a591515SWu XiangCheng * struct 张三 - 简短描述. 2593a591515SWu XiangCheng * @张三: 成员张三. 2603a591515SWu XiangCheng */ 2613a591515SWu XiangCheng struct 张三 { 2623a591515SWu XiangCheng int 张三; 2633a591515SWu XiangCheng /** 2643a591515SWu XiangCheng * @李四: 成员李四. 2653a591515SWu XiangCheng */ 2663a591515SWu XiangCheng int 李四; 2673a591515SWu XiangCheng /** 2683a591515SWu XiangCheng * @王五: 成员王五. 2693a591515SWu XiangCheng * 2703a591515SWu XiangCheng * 此处,成员描述可以为好几段. 2713a591515SWu XiangCheng */ 2723a591515SWu XiangCheng int 王五; 2733a591515SWu XiangCheng union { 2743a591515SWu XiangCheng /** @儿子: 单行描述. */ 2753a591515SWu XiangCheng int 儿子; 2763a591515SWu XiangCheng }; 2773a591515SWu XiangCheng /** @赵六: 描述@张三里面的结构体@赵六 */ 2783a591515SWu XiangCheng struct { 2793a591515SWu XiangCheng /** 2803a591515SWu XiangCheng * @赵六.女儿: 描述@张三.赵六里面的@女儿 2813a591515SWu XiangCheng */ 2823a591515SWu XiangCheng int 女儿; 2833a591515SWu XiangCheng } 赵六; 2843a591515SWu XiangCheng }; 2853a591515SWu XiangCheng 2863a591515SWu XiangChengTypedef文档 2873a591515SWu XiangCheng----------- 2883a591515SWu XiangCheng 2893a591515SWu XiangChengTypedef的kernel-doc文档注释的一般格式为:: 2903a591515SWu XiangCheng 2913a591515SWu XiangCheng /** 2923a591515SWu XiangCheng * typedef 类型名称 - 简短描述. 2933a591515SWu XiangCheng * 2943a591515SWu XiangCheng * 类型描述. 2953a591515SWu XiangCheng */ 2963a591515SWu XiangCheng 2973a591515SWu XiangCheng还可以记录带有函数原型的typedef:: 2983a591515SWu XiangCheng 2993a591515SWu XiangCheng /** 3003a591515SWu XiangCheng * typedef 类型名称 - 简短描述. 3013a591515SWu XiangCheng * @参数1: 参数1的描述 3023a591515SWu XiangCheng * @参数2: 参数2的描述 3033a591515SWu XiangCheng * 3043a591515SWu XiangCheng * 类型描述. 3053a591515SWu XiangCheng * 3063a591515SWu XiangCheng * Context: 锁(Locking)上下文. 3073a591515SWu XiangCheng * Return: 返回值的意义. 3083a591515SWu XiangCheng */ 3093a591515SWu XiangCheng typedef void (*类型名称)(struct v4l2_ctrl *参数1, void *参数2); 3103a591515SWu XiangCheng 3113a591515SWu XiangCheng高亮与交叉引用 3123a591515SWu XiangCheng-------------- 3133a591515SWu XiangCheng 3143a591515SWu XiangCheng在kernel-doc注释的描述文本中可以识别以下特殊模式,并将其转换为正确的 3153a591515SWu XiangChengreStructuredText标记和 `Sphinx C 域`_ 引用。 3163a591515SWu XiangCheng 3173a591515SWu XiangCheng.. attention:: 以下内容 **仅** 在kernel-doc注释中识别, **不会** 在普通的 3183a591515SWu XiangCheng reStructuredText文档中识别。 3193a591515SWu XiangCheng 3203a591515SWu XiangCheng``funcname()`` 3213a591515SWu XiangCheng 函数引用。 3223a591515SWu XiangCheng 3233a591515SWu XiangCheng``@parameter`` 3243a591515SWu XiangCheng 函数参数的名称(未交叉引用,仅格式化)。 3253a591515SWu XiangCheng 3263a591515SWu XiangCheng``%CONST`` 3273a591515SWu XiangCheng 常量的名称(未交叉引用,仅格式化)。 3283a591515SWu XiangCheng 3293a591515SWu XiangCheng````literal```` 3303a591515SWu XiangCheng 预格式化文本块。输出将使用等距字体。 3313a591515SWu XiangCheng 3323a591515SWu XiangCheng 若你需要使用在kernel-doc脚本或reStructuredText中有特殊含义的字符,则此功能 3333a591515SWu XiangCheng 非常有用。 3343a591515SWu XiangCheng 3353a591515SWu XiangCheng 若你需要在函数描述中使用类似于 ``%ph`` 的东西,这特别有用。 3363a591515SWu XiangCheng 3373a591515SWu XiangCheng``$ENVVAR`` 3383a591515SWu XiangCheng 环境变量名称(未交叉引用,仅格式化)。 3393a591515SWu XiangCheng 3403a591515SWu XiangCheng``&struct name`` 3413a591515SWu XiangCheng 结构体引用。 3423a591515SWu XiangCheng 3433a591515SWu XiangCheng``&enum name`` 3443a591515SWu XiangCheng 枚举引用。 3453a591515SWu XiangCheng 3463a591515SWu XiangCheng``&typedef name`` 3473a591515SWu XiangCheng Typedef引用。 3483a591515SWu XiangCheng 3493a591515SWu XiangCheng``&struct_name->member`` or ``&struct_name.member`` 3503a591515SWu XiangCheng 结构体或共用体成员引用。交叉引用将链接到结构体或共用体定义,而不是直接到成员。 3513a591515SWu XiangCheng 3523a591515SWu XiangCheng``&name`` 3533a591515SWu XiangCheng 泛类型引用。请首选上面描述的完整引用方式。此法主要是为了可能未描述的注释。 3543a591515SWu XiangCheng 3553a591515SWu XiangCheng从reStructuredText交叉引用 3563a591515SWu XiangCheng~~~~~~~~~~~~~~~~~~~~~~~~~~ 3573a591515SWu XiangCheng 3583a591515SWu XiangCheng无需额外的语法来从reStructuredText文档交叉引用kernel-do注释中定义的函数和类型。 3593a591515SWu XiangCheng只需以 ``()`` 结束函数名,并在类型之前写上 ``struct`` , ``union`` , ``enum`` 3603a591515SWu XiangCheng或 ``typedef`` 。 3613a591515SWu XiangCheng例如:: 3623a591515SWu XiangCheng 3633a591515SWu XiangCheng See foo(). 3643a591515SWu XiangCheng See struct foo. 3653a591515SWu XiangCheng See union bar. 3663a591515SWu XiangCheng See enum baz. 3673a591515SWu XiangCheng See typedef meh. 3683a591515SWu XiangCheng 3693a591515SWu XiangCheng若要在交叉引用链接中使用自定义文本,可以通过以下语法进行:: 3703a591515SWu XiangCheng 3713a591515SWu XiangCheng See :c:func:`my custom link text for function foo <foo>`. 3723a591515SWu XiangCheng See :c:type:`my custom link text for struct bar <bar>`. 3733a591515SWu XiangCheng 3743a591515SWu XiangCheng有关更多详细信息,请参阅 `Sphinx C 域`_ 文档。 3753a591515SWu XiangCheng 3763a591515SWu XiangCheng总述性文档注释 3773a591515SWu XiangCheng-------------- 3783a591515SWu XiangCheng 3793a591515SWu XiangCheng为了促进源代码和注释紧密联合,可以将kernel-doc文档块作为自由形式的注释,而 3803a591515SWu XiangCheng不是函数、结构、联合、枚举或typedef的绑定kernel-doc。例如,这可以用于解释 3813a591515SWu XiangCheng驱动程序或库代码的操作理论。 3823a591515SWu XiangCheng 3833a591515SWu XiangCheng这是通过使用带有节标题的 ``DOC:`` 节关键字来实现的。 3843a591515SWu XiangCheng 3853a591515SWu XiangCheng总述或高层级文档注释的一般格式为:: 3863a591515SWu XiangCheng 3873a591515SWu XiangCheng /** 3883a591515SWu XiangCheng * DOC: Theory of Operation 3893a591515SWu XiangCheng * 3903a591515SWu XiangCheng * The whizbang foobar is a dilly of a gizmo. It can do whatever you 3913a591515SWu XiangCheng * want it to do, at any time. It reads your mind. Here's how it works. 3923a591515SWu XiangCheng * 3933a591515SWu XiangCheng * foo bar splat 3943a591515SWu XiangCheng * 3953a591515SWu XiangCheng * The only drawback to this gizmo is that is can sometimes damage 3963a591515SWu XiangCheng * hardware, software, or its subject(s). 3973a591515SWu XiangCheng */ 3983a591515SWu XiangCheng 3993a591515SWu XiangCheng``DOC:`` 后面的标题用作源文件中的标题,但也用作提取文档注释的标识符。因此, 4003a591515SWu XiangCheng文件中的标题必须是唯一的。 4013a591515SWu XiangCheng 4023a591515SWu XiangCheng包含kernel-doc注释 4033a591515SWu XiangCheng================== 4043a591515SWu XiangCheng 4053a591515SWu XiangCheng文档注释可以被包含在任何使用专用kernel-doc Sphinx指令扩展的reStructuredText 4063a591515SWu XiangCheng文档中。 4073a591515SWu XiangCheng 4083a591515SWu XiangChengkernel-doc指令的格式如下:: 4093a591515SWu XiangCheng 4103a591515SWu XiangCheng .. kernel-doc:: source 4113a591515SWu XiangCheng :option: 4123a591515SWu XiangCheng 4133a591515SWu XiangCheng*source* 是相对于内核源代码树的源文件路径。 4143a591515SWu XiangCheng支持以下指令选项: 4153a591515SWu XiangCheng 4163a591515SWu XiangChengexport: *[source-pattern ...]* 4173a591515SWu XiangCheng 包括 *source* 中使用 ``EXPORT_SYMBOL`` 或 ``EXPORT_SYMBOL_GPL`` 导出的所有 4183a591515SWu XiangCheng 函数的文档,无论是在 *source* 中还是在 *source-pattern* 指定的任何文件中。 4193a591515SWu XiangCheng 4203a591515SWu XiangCheng 当kernel-doc注释被放置在头文件中,而 ``EXPORT_SYMBOL`` 和 ``EXPORT_SYMBOL_GPL`` 4213a591515SWu XiangCheng 位于函数定义旁边时, *source-pattern* 非常有用。 4223a591515SWu XiangCheng 4233a591515SWu XiangCheng 例子:: 4243a591515SWu XiangCheng 4253a591515SWu XiangCheng .. kernel-doc:: lib/bitmap.c 4263a591515SWu XiangCheng :export: 4273a591515SWu XiangCheng 4283a591515SWu XiangCheng .. kernel-doc:: include/net/mac80211.h 4293a591515SWu XiangCheng :export: net/mac80211/*.c 4303a591515SWu XiangCheng 4313a591515SWu XiangChenginternal: *[source-pattern ...]* 4323a591515SWu XiangCheng 包括 *source* 中所有在 *source* 或 *source-pattern* 的任何文件中都没有使用 4333a591515SWu XiangCheng ``EXPORT_SYMBOL`` 或 ``EXPORT_SYMBOL_GPL`` 导出的函数和类型的文档。 4343a591515SWu XiangCheng 4353a591515SWu XiangCheng 例子:: 4363a591515SWu XiangCheng 4373a591515SWu XiangCheng .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c 4383a591515SWu XiangCheng :internal: 4393a591515SWu XiangCheng 4403a591515SWu XiangChengidentifiers: *[ function/type ...]* 4413a591515SWu XiangCheng 在 *source* 中包含每个 *function* 和 *type* 的文档。如果没有指定 *function* , 4423a591515SWu XiangCheng 则 *source* 中所有函数和类型的文档都将包含在内。 4433a591515SWu XiangCheng 4443a591515SWu XiangCheng 例子:: 4453a591515SWu XiangCheng 4463a591515SWu XiangCheng .. kernel-doc:: lib/bitmap.c 4473a591515SWu XiangCheng :identifiers: bitmap_parselist bitmap_parselist_user 4483a591515SWu XiangCheng 4493a591515SWu XiangCheng .. kernel-doc:: lib/idr.c 4503a591515SWu XiangCheng :identifiers: 4513a591515SWu XiangCheng 4523a591515SWu XiangChengno-identifiers: *[ function/type ...]* 4533a591515SWu XiangCheng 排除 *source* 中所有 *function* 和 *type* 的文档。 4543a591515SWu XiangCheng 4553a591515SWu XiangCheng 例子:: 4563a591515SWu XiangCheng 4573a591515SWu XiangCheng .. kernel-doc:: lib/bitmap.c 4583a591515SWu XiangCheng :no-identifiers: bitmap_parselist 4593a591515SWu XiangCheng 4603a591515SWu XiangChengfunctions: *[ function/type ...]* 4613a591515SWu XiangCheng 这是“identifiers”指令的别名,已弃用。 4623a591515SWu XiangCheng 4633a591515SWu XiangChengdoc: *title* 4643a591515SWu XiangCheng 包含 *source* 中由 *title* 标题标识的 ``DOC:`` 文档段落。 *title* 中允许 4653a591515SWu XiangCheng 空格;不要在 *title* 上加引号。 *title* 仅用作段落的标识符,不包含在输出中。 4663a591515SWu XiangCheng 请确保在所附的reStructuredText文档中有适当的标题。 4673a591515SWu XiangCheng 4683a591515SWu XiangCheng 例子:: 4693a591515SWu XiangCheng 4703a591515SWu XiangCheng .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c 4713a591515SWu XiangCheng :doc: High Definition Audio over HDMI and Display Port 4723a591515SWu XiangCheng 4733a591515SWu XiangCheng如果没有选项,kernel-doc指令将包含源文件中的所有文档注释。 4743a591515SWu XiangCheng 4753a591515SWu XiangChengkernel-doc扩展包含在内核源代码树中,位于 ``Documentation/sphinx/kerneldoc.py`` 。 4763a591515SWu XiangCheng在内部,它使用 ``scripts/kernel-doc`` 脚本从源代码中提取文档注释。 4773a591515SWu XiangCheng 4783a591515SWu XiangCheng.. _kernel_doc_zh: 4793a591515SWu XiangCheng 4803a591515SWu XiangCheng如何使用kernel-doc生成手册(man)页 4813a591515SWu XiangCheng----------------------------------- 4823a591515SWu XiangCheng 4833a591515SWu XiangCheng如果您只想使用kernel-doc生成手册页,可以从内核git树这样做:: 4843a591515SWu XiangCheng 4853a591515SWu XiangCheng $ scripts/kernel-doc -man \ 4863a591515SWu XiangCheng $(git grep -l '/\*\*' -- :^Documentation :^tools) \ 4873a591515SWu XiangCheng | scripts/split-man.pl /tmp/man 4883a591515SWu XiangCheng 4893a591515SWu XiangCheng一些旧版本的git不支持路径排除语法的某些变体。 4903a591515SWu XiangCheng以下命令之一可能适用于这些版本:: 4913a591515SWu XiangCheng 4923a591515SWu XiangCheng $ scripts/kernel-doc -man \ 4933a591515SWu XiangCheng $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \ 4943a591515SWu XiangCheng | scripts/split-man.pl /tmp/man 4953a591515SWu XiangCheng 4963a591515SWu XiangCheng $ scripts/kernel-doc -man \ 4973a591515SWu XiangCheng $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \ 4983a591515SWu XiangCheng | scripts/split-man.pl /tmp/man 4993a591515SWu XiangCheng 500