linux-kernel - Re: linux-next: build warnings after merge of the jc

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] [day] [month] [year] [list]

Message-ID: <87a65c3w79.fsf@meer.lwn.net>
Date:   Mon, 31 Oct 2022 08:27:06 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Stephen Rothwell <sfr@...b.auug.org.au>
Cc:     Binbin Zhou <zhoubinbin@...ngson.cn>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Next Mailing List <linux-next@...r.kernel.org>
Subject: Re: linux-next: build warnings after merge of the jc_docs tree

Stephen Rothwell <sfr@...b.auug.org.au> writes:

> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/core-api/timekeeping.rst:16: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:26.
> Declaration is '.. c:function:: ktime_t ktime_get(void)'.

[...]

> Presumably introduced by commit
>
>   d24c911bd031 ("docs/zh_CN: core-api: Add timekeeping Chinese translation")
>
> but I have no idea why :-(

"Why" is the ".. c:function::" definitions in core-api/timekeeping.rst.
The translation duplicated those, leading to the warnings you mention.
I should have caught that, but the old (fast!) version of sphinx I used
to check things doesn't put out that warning.  I'm just going to have to
be more patient, I guess.

I've reverted the commit in question.  I'm not sure what the best
practice should be for translating documents with those declarations in
them.  Perhaps the function prototype should just go into a literal
block without the c:function declaration?

Thanks,

jon