From: Yanteng Si Date: Mon, 22 Nov 2021 07:40:28 +0000 (+0800) Subject: docs/zh_CN: move sparse into dev-tools X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=274f4df3bf09a28a64970834650a1b1f8ad640a4;p=linux.git docs/zh_CN: move sparse into dev-tools ../zh_CN/saprse.txt is alone at here, let's move it to ../zh_CN/dev-tools/sparse.rst. Signed-off-by: Yanteng Si Reviewed-by: Alex Shi Link: https://lore.kernel.org/r/0f1182add7afe4e3b42398353a823d1b4dcf5147.1637565886.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/translations/zh_CN/dev-tools/index.rst b/Documentation/translations/zh_CN/dev-tools/index.rst index 0f770b8664e9a..77a8c44cdf49a 100644 --- a/Documentation/translations/zh_CN/dev-tools/index.rst +++ b/Documentation/translations/zh_CN/dev-tools/index.rst @@ -22,13 +22,13 @@ Documentation/translations/zh_CN/dev-tools/testing-overview.rst :maxdepth: 2 testing-overview + sparse gcov kasan Todolist: - coccinelle - - sparse - kcov - ubsan - kmemleak diff --git a/Documentation/translations/zh_CN/dev-tools/sparse.rst b/Documentation/translations/zh_CN/dev-tools/sparse.rst new file mode 100644 index 0000000000000..0f444b83d6395 --- /dev/null +++ b/Documentation/translations/zh_CN/dev-tools/sparse.rst @@ -0,0 +1,91 @@ +Chinese translated version of Documentation/dev-tools/sparse.rst + +If you have any comment or update to the content, please contact the +original document maintainer directly. However, if you have a problem +communicating in English you can also ask the Chinese maintainer for +help. Contact the Chinese maintainer if this translation is outdated +or if there is a problem with the translation. + +Chinese maintainer: Li Yang +--------------------------------------------------------------------- +Documentation/dev-tools/sparse.rst 的中文翻译 + +如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 +交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 +译存在问题，请联系中文版维护者。 + +中文版维护者： 李阳 Li Yang +中文版翻译者： 李阳 Li Yang + + +以下为正文 +--------------------------------------------------------------------- + +Copyright 2004 Linus Torvalds +Copyright 2004 Pavel Machek +Copyright 2006 Bob Copeland + +使用 sparse 工具做类型检查 +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +"__bitwise" 是一种类型属性，所以你应该这样使用它： + + typedef int __bitwise pm_request_t; + + enum pm_request { + PM_SUSPEND = (__force pm_request_t) 1, + PM_RESUME = (__force pm_request_t) 2 + }; + +这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force" +是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转 +换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将 +会使用那个类型做为底层实现。 + +而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc +看来它们只不过是普通的整数。 + +坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int +__bitwise"类型。 + +所以更简单的办法只要这样做： + + typedef int __bitwise pm_request_t; + + #define PM_SUSPEND ((__force pm_request_t) 1) + #define PM_RESUME ((__force pm_request_t) 2) + +现在你就有了严格的类型检查所需要的所有基础架构。 + +一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而 +不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方 +式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说 +常数"0"确实是特殊的。 + +获取 sparse 工具 +~~~~~~~~~~~~~~~~ + +你可以从 Sparse 的主页获取最新的发布版本： + + http://www.kernel.org/pub/linux/kernel/people/josh/sparse/ + +或者，你也可以使用 git 克隆最新的 sparse 开发版本： + + git://git.kernel.org/pub/scm/linux/kernel/git/josh/sparse.git + +一旦你下载了源码，只要以普通用户身份运行： + + make + make install + +它将会被自动安装到你的 ~/bin 目录下。 + +使用 sparse 工具 +~~~~~~~~~~~~~~~~ + +用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。 +或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。 +如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。 + +make 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自 +动向 sparse 工具传递 -Wbitwise 参数。 diff --git a/Documentation/translations/zh_CN/sparse.txt b/Documentation/translations/zh_CN/sparse.txt deleted file mode 100644 index 0f444b83d6395..0000000000000 --- a/Documentation/translations/zh_CN/sparse.txt +++ /dev/null @@ -1,91 +0,0 @@ -Chinese translated version of Documentation/dev-tools/sparse.rst - -If you have any comment or update to the content, please contact the -original document maintainer directly. However, if you have a problem -communicating in English you can also ask the Chinese maintainer for -help. Contact the Chinese maintainer if this translation is outdated -or if there is a problem with the translation. - -Chinese maintainer: Li Yang ---------------------------------------------------------------------- -Documentation/dev-tools/sparse.rst 的中文翻译 - -如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 -交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 -译存在问题，请联系中文版维护者。 - -中文版维护者： 李阳 Li Yang -中文版翻译者： 李阳 Li Yang - - -以下为正文 ---------------------------------------------------------------------- - -Copyright 2004 Linus Torvalds -Copyright 2004 Pavel Machek -Copyright 2006 Bob Copeland - -使用 sparse 工具做类型检查 -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -"__bitwise" 是一种类型属性，所以你应该这样使用它： - - typedef int __bitwise pm_request_t; - - enum pm_request { - PM_SUSPEND = (__force pm_request_t) 1, - PM_RESUME = (__force pm_request_t) 2 - }; - -这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force" -是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转 -换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将 -会使用那个类型做为底层实现。 - -而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc -看来它们只不过是普通的整数。 - -坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int -__bitwise"类型。 - -所以更简单的办法只要这样做： - - typedef int __bitwise pm_request_t; - - #define PM_SUSPEND ((__force pm_request_t) 1) - #define PM_RESUME ((__force pm_request_t) 2) - -现在你就有了严格的类型检查所需要的所有基础架构。 - -一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而 -不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方 -式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说 -常数"0"确实是特殊的。 - -获取 sparse 工具 -~~~~~~~~~~~~~~~~ - -你可以从 Sparse 的主页获取最新的发布版本： - - http://www.kernel.org/pub/linux/kernel/people/josh/sparse/ - -或者，你也可以使用 git 克隆最新的 sparse 开发版本： - - git://git.kernel.org/pub/scm/linux/kernel/git/josh/sparse.git - -一旦你下载了源码，只要以普通用户身份运行： - - make - make install - -它将会被自动安装到你的 ~/bin 目录下。 - -使用 sparse 工具 -~~~~~~~~~~~~~~~~ - -用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。 -或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。 -如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。 - -make 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自 -动向 sparse 工具传递 -Wbitwise 参数。