Lines Matching +full:pm +full:- +full:api

1 .. SPDX-License-Identifier: GPL-2.0
3 .. include:: ../disclaimer-zh_CN.rst
5 :Original: Documentation/doc-guide/contributing.rst
23 ----------------
41 另一个重点是，文档警告常常由C代码里kernel-doc注释中的问题引起。虽然文档维护
48   	- Resource-managed devfreq_register_notifier()
50   	- Resource-managed devfreq_unregister_notifier()
54 简单看一下上面给出的源文件，会发现几个kernel-doc注释，如下所示::
58    	- Resource-managed devfreq_register_notifier()
70   [PATCH] PM / devfreq: Fix two malformed kerneldoc comments
73   resulting in these doc-build warnings:
76   	  - Resource-managed devfreq_register_notifier()
78   	  - Resource-managed devfreq_unregister_notifier()
82   Signed-off-by: Jonathan Corbet <corbet@lwn.net>
83   ---
84    drivers/devfreq/devfreq.c | 4 ++--
85    1 file changed, 2 insertions(+), 2 deletions(-)
87   diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
89   --- a/drivers/devfreq/devfreq.c
91   @@ -1814,7 +1814,7 @@ static void devm_devfreq_notifier_release(struct device *dev, void *res)
95   -	- Resource-managed devfreq_register_notifier()
96   + *	- Resource-managed devfreq_register_notifier()
100   @@ -1850,7 +1850,7 @@ EXPORT_SYMBOL(devm_devfreq_register_notifier);
104   -	- Resource-managed devfreq_unregister_notifier()
105   + *	- Resource-managed devfreq_unregister_notifier()
109   --
113 个教训：在深入研究问题之前，一定要检查linux-next树，看看问题是否已经修复。
120 “迷失的”kernel-doc注释
123 开发者被鼓励去为他们的代码写kernel-doc注释，但是许多注释从未被引入文档构建。
124 这使得这些信息更难找到，例如使Sphinx无法生成指向该文档的链接。将 ``kernel-doc``
127 ``scripts/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。
130 使用的kernel-doc注释；除非这些注释放在专门针对相关子系统开发人员的文档中，
144  - 内核文档中用美式和英式英语拼写皆可，没有必要互相倒换。
146  - 在内核文档中，没必要讨论句点后面应该跟一个还是两个空格的问题。其他一些有
161  - 对2.x内核的引用
162  - 指向SourceForge存储库
163  - 历史记录除了拼写错误啥也没有持续几年
164  - 讨论Git之前时代的工作流
195  - Documentation/translations/zh_CN/admin-guide/index.rst
196  - Documentation/core-api/index.rst
197  - Documentation/driver-api/index.rst
198  - Documentation/userspace-api/index.rst