linux-kernel - Re: [PATCH v6] docs/zh_CN: Add dev-tools/kcsan Chinese translation

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: <64426130-d59a-47a1-8bf2-3b72fb0cc030@hust.edu.cn>
Date: Sat, 17 Aug 2024 12:59:16 +0800
From: Haoyang Liu <tttturtleruss@...t.edu.cn>
To: Jonathan Corbet <corbet@....net>, Alex Shi <alexs@...nel.org>,
 Yanteng Si <siyanteng@...ngson.cn>, Nathan Chancellor <nathan@...nel.org>,
 Nick Desaulniers <ndesaulniers@...gle.com>, Bill Wendling
 <morbo@...gle.com>, Justin Stitt <justinstitt@...gle.com>
Cc: hust-os-kernel-patches@...glegroups.com, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, llvm@...ts.linux.dev
Subject: Re: [PATCH v6] docs/zh_CN: Add dev-tools/kcsan Chinese translation


在 2024/8/17 6:28, Jonathan Corbet 写道:
> Haoyang Liu <tttturtleruss@...t.edu.cn> writes:
>
>> Translate dev-tools/kcsan commit 31f605a308e6
>> ("kcsan, compiler_types: Introduce __data_racy type qualifier")
>> into Chinese and add it in dev-tools/zh_CN/index.rst
>>
>> Signed-off-by: Haoyang Liu <tttturtleruss@...t.edu.cn>
>> Reviewed-by: Yanteng Si <siyanteng@...ngson.cn>
>> ---
>> v5 -> v6: Fix a typo.
>> v4 -> v5: Translate link into Chinese as well according to reviewer's advice.
>> v3 -> v4: Added original English text for proper nouns and modified some unclear experessions.
>> v2 -> v3: Revised some sentences based on reviewer's suggestions and updated the KTSAN url.
>> v1 -> v2: Added commit tag and fixed style problems according to reviewer's suggestions.
>>
>>   .../translations/zh_CN/dev-tools/index.rst    |   2 +-
>>   .../translations/zh_CN/dev-tools/kcsan.rst    | 321 ++++++++++++++++++
>>   2 files changed, 322 insertions(+), 1 deletion(-)
>>   create mode 100644 Documentation/translations/zh_CN/dev-tools/kcsan.rst
> So I applied this, but ended up unapplying it.  It adds a whole pile of
> docs build warnings:
>
> Documentation/translations/zh_CN/dev-tools/kcsan:223: ./include/linux/kcsan-checks.h:370: WARNING: Duplicate C declaration, also defined at dev-tools/kcsan:370.
> Declaration is '.. c:macro:: ASSERT_EXCLUSIVE_WRITER'.
> Documentation/translations/zh_CN/dev-tools/kcsan:223: ./include/linux/kcsan-checks.h:419: WARNING: Duplicate C declaration, also defined at dev-tools/kcsan:419.
> Declaration is '.. c:macro:: ASSERT_EXCLUSIVE_WRITER_SCOPED'.
> Documentation/translations/zh_CN/dev-tools/kcsan:223: ./include/linux/kcsan-checks.h:451: WARNING: Duplicate C declaration, also defined at dev-tools/kcsan:451.
> Declaration is '.. c:macro:: ASSERT_EXCLUSIVE_ACCESS'.
>
> [...]
>
> You really do need to do a build test before sending changes like this.
>
> The problem is the duplicated inclusion caused by the kernel-doc
> directive:
>
>> +.. kernel-doc:: include/linux/kcsan-checks.h
>> +    :functions: ASSERT_EXCLUSIVE_WRITER ASSERT_EXCLUSIVE_WRITER_SCOPED
>> +                ASSERT_EXCLUSIVE_ACCESS ASSERT_EXCLUSIVE_ACCESS_SCOPED
>> +                ASSERT_EXCLUSIVE_BITS
>>
> We really just can't do that with the current build system; the best
> thing is to put in a note saying to see the original document for those
> declarations.

I'm sorry for the warnings my patch introduced. I thought they were 
harmless so I ignored them. I will replace the duplicated inclusion with 
a note and a link to the original document.

I apologize for my mistake.


Thanks,

Haoyang

>
> This would be good to fix, perhaps with a variant of kernel-doc that
> doesn't generate the duplicated declarations, but until somebody does
> that we have to work around it.
>
> Thanks,
>
> jon