linux-kernel - Re: [PATCH v2,1/2] doc: zh_CN: index files in filesystems subdirectory

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: <20200316075735.67793bfc@coco.lan>
Date:   Mon, 16 Mar 2020 07:57:35 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Wang Wenhu <wenhu.wang@...o.com>
Cc:     Jonathan Corbet <corbet@....net>, Vivek Goyal <vgoyal@...hat.com>,
        Stefan Hajnoczi <stefanha@...hat.com>,
        Miklos Szeredi <miklos@...redi.hu>,
        Harry Wei <harryxiyou@...il.com>,
        Alex Shi <alex.shi@...ux.alibaba.com>,
        "Daniel W. S. Almeida" <dwlsalmeida@...il.com>,
        Eric Biggers <ebiggers@...gle.com>,
        Jaskaran Singh <jaskaransingh7654321@...il.com>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        virtualization@...ts.linux-foundation.org,
        linux-fsdevel@...r.kernel.org, kernel@...o.com
Subject: Re: [PATCH v2,1/2] doc: zh_CN: index files in filesystems
 subdirectory

Em Sun, 15 Mar 2020 08:52:38 -0700
Wang Wenhu <wenhu.wang@...o.com> escreveu:

> Add filesystems subdirectory into the table of Contents for zh_CN,
> all translations residing on it would be indexed conveniently.
> 
> Signed-off-by: Wang Wenhu <wenhu.wang@...o.com>
> ---
> Changelog:
>  - v2 added SPDX header
> ---
>  Documentation/filesystems/index.rst           |  2 ++
>  .../translations/zh_CN/filesystems/index.rst  | 29 +++++++++++++++++++
>  Documentation/translations/zh_CN/index.rst    |  1 +
>  3 files changed, 32 insertions(+)
>  create mode 100644 Documentation/translations/zh_CN/filesystems/index.rst
> 
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 386eaad008b2..ab47d5b1f092 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -1,3 +1,5 @@
> +.. _filesystems_index:
> +
>  ===============================
>  Filesystems in the Linux kernel
>  ===============================
> diff --git a/Documentation/translations/zh_CN/filesystems/index.rst b/Documentation/translations/zh_CN/filesystems/index.rst
> new file mode 100644
> index 000000000000..0a2cabfeaf7b
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/filesystems/index.rst
> @@ -0,0 +1,29 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. raw:: latex
> +
> +	\renewcommand\thesection*
> +	\renewcommand\thesubsection*

Out of curiosity: why do you add those?

My experience with raw latex is that adding things like that tend to
break with different Sphinx versions. So, if this is really needed, I
suggest you to test with at least Sphinx 1.7.9 and with the latest
version, to be sure that it won't cause troubles.

Except for that, patch looks ok to me.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Regards,
Mauro

> +
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: :ref:`Documentation/filesystems/index.rst <filesystems_index>`
> +:Translator: Wang Wenhu <wenhu.wang@...o.com>
> +
> +.. _cn_filesystems_index:
> +
> +========================
> +Linux Kernel中的文件系统
> +========================
> +
> +这份正在开发的手册或许在未来某个辉煌的日子里以易懂的形式将Linux虚拟\
> +文件系统（VFS）层以及基于其上的各种文件系统如何工作呈现给大家。当前\
> +可以看到下面的内容。
> +
> +文件系统
> +========
> +
> +文件系统实现文档。
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
> index d3165535ec9e..76850a5dd982 100644
> --- a/Documentation/translations/zh_CN/index.rst
> +++ b/Documentation/translations/zh_CN/index.rst
> @@ -14,6 +14,7 @@
>     :maxdepth: 2
>  
>     process/index
> +   filesystems/index
>  
>  目录和表格
>  ----------



Thanks,
Mauro