linux-kernel - Re: [PATCH] doc/zh_CN: add Chinese document coding style reminder

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: <CAJy-AmkPm3ims64OHbiT7KgT=ocxGKO_yTFigzORBgVc_7VFDg@mail.gmail.com>
Date:   Thu, 9 Dec 2021 10:45:37 +0800
From:   Alex Shi <seakeel@...il.com>
To:     yanteng si <siyanteng01@...il.com>
Cc:     Alex Shi <alexs@...nel.org>, Tang Yizhou <tangyizhou@...wei.com>,
        Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] doc/zh_CN: add Chinese document coding style reminder

On Thu, Dec 9, 2021 at 9:34 AM yanteng si <siyanteng01@...il.com> wrote:
>
> <alexs@...nel.org> 于2021年12月8日周三 19:41写道：
> >
> > From: Alex Shi <alexs@...nel.org>
> >
> > The coding style requirement for Chinese document is easy to be overlooked.
> > Add the request as a remdiner.
> >
> > Signed-off-by: Alex Shi <alexs@...nel.org>
> > Cc: Yanteng Si <siyanteng01@...il.com>
> > Cc: Tang Yizhou <tangyizhou@...wei.com>
> > Cc: Jonathan Corbet <corbet@....net>
> > Cc: linux-doc@...r.kernel.org
> > Cc: linux-kernel@...r.kernel.org
> > ---
> >  Documentation/translations/zh_CN/index.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
> > index a34e58733ac8..8c2786ed0279 100644
> > --- a/Documentation/translations/zh_CN/index.rst
> > +++ b/Documentation/translations/zh_CN/index.rst
> > @@ -23,6 +23,10 @@
> >  另外，随时欢迎您对内核文档进行改进；如果您想提供帮助，请加入vger.kernel.org
> >  上的linux-doc邮件列表。
> >
> > +顺便说下，中文文档也需要遵守内核编码风格，风格中中文和英文的主要不同就是中文
> > +的字符标点占用两个英文字符宽度， 所以，当英文要求不要超过每行100个字符时，
> > +中文就不要超过50个字符。另外，也要注意'-'，'=' 等符号与相关标题的对齐。
> How about:
> 另外，'-'，'=' 等符号需要与相关标题对齐, 为了照顾没有图形界面和习惯用vi查阅文档
> 的开发者，中文文档的文本块、段落等也应像英文文档那样整整齐齐。
>
> 在将补丁提交到社区之前，一定要进行必要的checkpatch.pl检查和编译测试，网页版
> 文档在部分浏览器中暂时可能会出现多余的空格，目前已知firefox正常，据了解，浏
> 览器规范草案中已有该问题的解决方案，将来有希望解决。

nice.

>
> .. 小技巧: 翻译时跟随英文文本块换行无需关心中文每行是否超字数，也不用担心漏掉空
>                行和缩进以及漏翻译，因为我们只需原地进行中英文字符串替换就可以了。

the line by line replace may lead to unalignment issue, do we need this tips?

Thanks
>
> Thanks,
> Yanteng
> > +
> >  许可证文档
> >  ----------
> >
> > --
> > 2.27.0
> >