linux-kernel - Re: [PATCH] docs/zh_CN: add the translation of kbuild/headers

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <d5e63e2a-c203-4c55-bbfe-537f5dd0b494@gmail.com>
Date: Sun, 28 Jul 2024 10:23:54 +0800
From: Alex Shi <seakeel@...il.com>
To: Dongliang Mu <dzm91@...t.edu.cn>, Alex Shi <alexs@...nel.org>,
 Yanteng Si <siyanteng@...ngson.cn>, Jonathan Corbet <corbet@....net>,
 Nathan Chancellor <nathan@...nel.org>,
 Nick Desaulniers <ndesaulniers@...gle.com>, Bill Wendling
 <morbo@...gle.com>, Justin Stitt <justinstitt@...gle.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 llvm@...ts.linux.dev
Subject: Re: [PATCH] docs/zh_CN: add the translation of
 kbuild/headers_install.rst


LGTM,
Reviewed-by: Alex Shi <alexs@...nel.org>

On 7/26/24 10:57 PM, Dongliang Mu wrote:
> Finish the translation of kbuild/headers_install.rst and
> kbuild/index.rst, then add kbuild into zh_CN/index.rst.
> 
> Update to commit 5b67fbfc32b5 ("Merge tag 'kbuild-v5.7' of
> git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild")
> 
> Signed-off-by: Dongliang Mu <dzm91@...t.edu.cn>
> ---
>  Documentation/translations/zh_CN/index.rst    |  2 +-
>  .../zh_CN/kbuild/headers_install.rst          | 39 +++++++++++++++++++
>  .../translations/zh_CN/kbuild/index.rst       | 35 +++++++++++++++++
>  3 files changed, 75 insertions(+), 1 deletion(-)
>  create mode 100644 Documentation/translations/zh_CN/kbuild/headers_install.rst
>  create mode 100644 Documentation/translations/zh_CN/kbuild/index.rst
> 
> diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
> index 20b9d4270d1f..7574e1673180 100644
> --- a/Documentation/translations/zh_CN/index.rst
> +++ b/Documentation/translations/zh_CN/index.rst
> @@ -89,10 +89,10 @@ TODOList:
>     admin-guide/index
>     admin-guide/reporting-issues.rst
>     userspace-api/index
> +   内核构建系统 <kbuild/index>
>  
>  TODOList:
>  
> -* 内核构建系统 <kbuild/index>
>  * 用户空间工具 <tools/index>
>  
>  也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。
> diff --git a/Documentation/translations/zh_CN/kbuild/headers_install.rst b/Documentation/translations/zh_CN/kbuild/headers_install.rst
> new file mode 100644
> index 000000000000..50ab819a7f96
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/kbuild/headers_install.rst
> @@ -0,0 +1,39 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/kbuild/headers_install.rst
> +:Translator: 慕冬亮 Dongliang Mu <dzm91@...t.edu.cn>
> +
> +============================
> +导出内核头文件供用户空间使用
> +============================
> +
> +"make headers_install" 命令以适合于用户空间程序的形式导出内核头文件。
> +
> +Linux 内核导出的头文件描述了用户空间程序尝试使用内核服务的 API。这些内核
> +头文件被系统的 C 库（例如 glibc 和 uClibc）用于定义可用的系统调用，以及
> +与这些系统调用一起使用的常量和结构。C 库的头文件包括来自 linux 子目录的
> +内核头文件。系统的 libc 头文件通常被安装在默认位置 /usr/include，而内核
> +头文件在该位置的子目录中（主要是 /usr/include/linux 和 /usr/include/asm）。
> +
> +内核头文件向后兼容，但不向前兼容。这意味着使用旧内核头文件的 C 库构建的程序
> +可以在新内核上运行（尽管它可能无法访问新特性），但使用新内核头文件构建的程序
> +可能无法在旧内核上运行。
> +
> +"make headers_install" 命令可以在内核源代码的顶层目录中运行（或使用标准
> +的树外构建）。它接受两个可选参数::
> +
> +  make headers_install ARCH=i386 INSTALL_HDR_PATH=/usr
> +
> +ARCH 表明为其生成头文件的架构，默认为当前架构。导出内核头文件的 linux/asm
> +目录是基于特定平台的，要查看支持架构的完整列表，使用以下命令::
> +
> +  ls -d include/asm-* | sed 's/.*-//'
> +
> +INSTALL_HDR_PATH 表明头文件的安装位置，默认为 "./usr"。
> +
> +该命令会在 INSTALL_HDR_PATH 中自动创建创建一个 'include' 目录，而头文件
> +会被安装在 INSTALL_HDR_PATH/include 中。
> +
> +内核头文件导出的基础设施由 David Woodhouse <dwmw2@...radead.org> 维护。
> \ No newline at end of file
> diff --git a/Documentation/translations/zh_CN/kbuild/index.rst b/Documentation/translations/zh_CN/kbuild/index.rst
> new file mode 100644
> index 000000000000..b9feb56b846a
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/kbuild/index.rst
> @@ -0,0 +1,35 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/kbuild/index
> +:Translator: 慕冬亮 Dongliang Mu <dzm91@...t.edu.cn>
> +
> +============
> +内核编译系统
> +============
> +
> +.. toctree::
> +    :maxdepth: 1
> +
> +    headers_install
> +
> +TODO:
> +
> +- kconfig-language
> +- kconfig-macro-language
> +- kbuild
> +- kconfig
> +- makefiles
> +- modules
> +- issues
> +- reproducible-builds
> +- gcc-plugins
> +- llvm
> +
> +.. only::  subproject and html
> +
> +   目录
> +   =====
> +
> +   * :ref:`genindex`