linux-next: build warning after merge of the jc_docs tree

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 809 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
Text in column margin in table line 6.

===========         =====
时钟                drivers/clk/ingenic/tcu.c
中断                drivers/irqchip/irq-ingenic-tcu.c
定时器              drivers/clocksource/ingenic-timer.c
OST                 drivers/clocksource/ingenic-ost.c
脉冲宽度调制器      drivers/pwm/pwm-jz4740.c
看门狗              drivers/watchdog/jz4740_wdt.c
===========         =====

Introduced by commit

  419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")

This looks different in my editor :-(  I guess the font matters.
-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the jc_docs tree

[Jonathan Corbet]

On Wed, 13 Jan 2021 15:07:48 +1100
Stephen Rothwell <sfr@canb.auug.org.au> wrote:

> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
> Text in column margin in table line 6.
> 
> ===========         =====
> 时钟                drivers/clk/ingenic/tcu.c
> 中断                drivers/irqchip/irq-ingenic-tcu.c
> 定时器              drivers/clocksource/ingenic-timer.c
> OST                 drivers/clocksource/ingenic-ost.c
> 脉冲宽度调制器      drivers/pwm/pwm-jz4740.c
> 看门狗              drivers/watchdog/jz4740_wdt.c
> ===========         =====
> 
> Introduced by commit
> 
>   419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")

Memo to self: you can't skip doing a new build even for simple
translations that obviously shouldn't add any new problems.  Sorry for the
noise, I've applied fixes from Lukas Bulwahn for all of this whole mess of
errors.

Yantang, *please* do not submit documentation patches without having done
a docs build to make sure things work as expected!

Thanks,

jon

Re: Re: linux-next: build warning after merge of the jc_docs tree

[司延腾]

Sorry, I apologize for the inconvenience caused to you, I do not quibble, but I have been studying for nearly a week, please pay attention to my future patches.

Thanks
Yanteng


> -----原始邮件-----
&gt; 发件人: "Jonathan Corbet" <corbet@lwn.net>
&gt; 发送时间: 2021-01-14 07:27:30 (星期四)
&gt; 收件人: "Stephen Rothwell" <sfr@canb.auug.org.au>
&gt; 抄送: "Yanteng Si" <siyanteng@loongson.cn>, "Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>, "Linux Next Mailing List" <linux-next@vger.kernel.org>
&gt; 主题: Re: linux-next: build warning after merge of the jc_docs tree
&gt; 
&gt; On Wed, 13 Jan 2021 15:07:48 +1100
&gt; Stephen Rothwell <sfr@canb.auug.org.au> wrote:
&gt; 
&gt; &gt; After merging the jc_docs tree, today's linux-next build (htmldocs)
&gt; &gt; produced this warning:
&gt; &gt; 
&gt; &gt; Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
&gt; &gt; Text in column margin in table line 6.
&gt; &gt; 
&gt; &gt; ===========         =====
&gt; &gt; 时钟                drivers/clk/ingenic/tcu.c
&gt; &gt; 中断                drivers/irqchip/irq-ingenic-tcu.c
&gt; &gt; 定时器              drivers/clocksource/ingenic-timer.c
&gt; &gt; OST                 drivers/clocksource/ingenic-ost.c
&gt; &gt; 脉冲宽度调制器      drivers/pwm/pwm-jz4740.c
&gt; &gt; 看门狗              drivers/watchdog/jz4740_wdt.c
&gt; &gt; ===========         =====
&gt; &gt; 
&gt; &gt; Introduced by commit
&gt; &gt; 
&gt; &gt;   419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")
&gt; 
&gt; Memo to self: you can't skip doing a new build even for simple
&gt; translations that obviously shouldn't add any new problems.  Sorry for the
&gt; noise, I've applied fixes from Lukas Bulwahn for all of this whole mess of
&gt; errors.
&gt; 
&gt; Yantang, *please* do not submit documentation patches without having done
&gt; a docs build to make sure things work as expected!
&gt; 
&gt; Thanks,
&gt; 
&gt; jon


</sfr@canb.auug.org.au></linux-next@vger.kernel.org></linux-kernel@vger.kernel.org></siyanteng@loongson.cn></sfr@canb.auug.org.au></corbet@lwn.net>

Re: linux-next: build warning after merge of the jc_docs tree

[Jonathan Corbet]

On Thu, 21 Jan 2021 10:07:48 +0800 (GMT+08:00)
司延腾 <siyanteng@loongson.cn> wrote:

> Sorry, I apologize for the inconvenience caused to you, I do not
> quibble, but I have been studying for nearly a week, please pay
> attention to my future patches.

Please don't worry, mistakes happen; we just have to learn from them.  I'm
looking forward to your future work.

Thanks,

jon

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 479 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'

and 636 new similar warnings :-(

Exposed by commit

  b77fdd6a48e6 ("scripts/kernel-doc: restore warning for Excess struct/union")

I am not sure what we should do about this ... last Friday I only
got about 18 lines of warnings.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the jc_docs tree

[Jonathan Corbet]

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

> Hi all,
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced this warning:
>
> include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>
> and 636 new similar warnings :-(
>
> Exposed by commit
>
>   b77fdd6a48e6 ("scripts/kernel-doc: restore warning for Excess struct/union")
>
> I am not sure what we should do about this ... last Friday I only
> got about 18 lines of warnings.

The warnings were expected, of course.

The alternatives are to fix the docs or to revert b77fdd6a48e6,
pretending that all those kerneldoc errors don't actually exist.  The
fixes should be pretty easy to do (and there's far less of them than it
seems from the number of warnings).  I can't get there right away but if
nobody beats me to it I'll try to toss some patches together.

Thanks,

jon

Re: linux-next: build warning after merge of the jc_docs tree

[Randy Dunlap]

On 12/18/23 06:18, Jonathan Corbet wrote:
> Stephen Rothwell <sfr@canb.auug.org.au> writes:
> 
>> Hi all,
>>
>> After merging the jc_docs tree, today's linux-next build (htmldocs)
>> produced this warning:
>>
>> include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>>
>> and 636 new similar warnings :-(
>>
>> Exposed by commit
>>
>>   b77fdd6a48e6 ("scripts/kernel-doc: restore warning for Excess struct/union")
>>
>> I am not sure what we should do about this ... last Friday I only
>> got about 18 lines of warnings.
> 
> The warnings were expected, of course.
> 
> The alternatives are to fix the docs or to revert b77fdd6a48e6,
> pretending that all those kerneldoc errors don't actually exist.  The
> fixes should be pretty easy to do (and there's far less of them than it
> seems from the number of warnings).  I can't get there right away but if
> nobody beats me to it I'll try to toss some patches together.

Hi Jon,

Attempt at a little coordination:

It looks like you are working on some net-related patches for this.
I am currently working on fs/ and kernel/ patches.

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: linux-next: build warning after merge of the jc_docs tree

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> On 12/18/23 06:18, Jonathan Corbet wrote:
>> Stephen Rothwell <sfr@canb.auug.org.au> writes:
>> 
>>> Hi all,
>>>
>>> After merging the jc_docs tree, today's linux-next build (htmldocs)
>>> produced this warning:
>>>
>>> include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>>>
>>> and 636 new similar warnings :-(
>>>
>>> Exposed by commit
>>>
>>>   b77fdd6a48e6 ("scripts/kernel-doc: restore warning for Excess struct/union")
>>>
>>> I am not sure what we should do about this ... last Friday I only
>>> got about 18 lines of warnings.
>> 
>> The warnings were expected, of course.
>> 
>> The alternatives are to fix the docs or to revert b77fdd6a48e6,
>> pretending that all those kerneldoc errors don't actually exist.  The
>> fixes should be pretty easy to do (and there's far less of them than it
>> seems from the number of warnings).  I can't get there right away but if
>> nobody beats me to it I'll try to toss some patches together.
>
> Hi Jon,
>
> Attempt at a little coordination:
>
> It looks like you are working on some net-related patches for this.
> I am currently working on fs/ and kernel/ patches.

Oops...I did a few net ones now; they are all sent and I'm done for
today.

Thanks for working on these too!

jon

Re: linux-next: build warning after merge of the jc_docs tree

[Randy Dunlap]

On 12/19/23 16:02, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> On 12/18/23 06:18, Jonathan Corbet wrote:
>>> Stephen Rothwell <sfr@canb.auug.org.au> writes:
>>>
>>>> Hi all,
>>>>
>>>> After merging the jc_docs tree, today's linux-next build (htmldocs)
>>>> produced this warning:
>>>>
>>>> include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>>>>
>>>> and 636 new similar warnings :-(
>>>>
>>>> Exposed by commit
>>>>
>>>>   b77fdd6a48e6 ("scripts/kernel-doc: restore warning for Excess struct/union")
>>>>
>>>> I am not sure what we should do about this ... last Friday I only
>>>> got about 18 lines of warnings.
>>>
>>> The warnings were expected, of course.
>>>
>>> The alternatives are to fix the docs or to revert b77fdd6a48e6,
>>> pretending that all those kerneldoc errors don't actually exist.  The
>>> fixes should be pretty easy to do (and there's far less of them than it
>>> seems from the number of warnings).  I can't get there right away but if
>>> nobody beats me to it I'll try to toss some patches together.
>>
>> Hi Jon,
>>
>> Attempt at a little coordination:
>>
>> It looks like you are working on some net-related patches for this.
>> I am currently working on fs/ and kernel/ patches.
> 
> Oops...I did a few net ones now; they are all sent and I'm done for
> today.

No Oops needed.  You can have net. I'll stay away from it.

> Thanks for working on these too!
> 
> jon

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 324 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/filesystems/proc.rst:697: WARNING: Unexpected indentation.

Introduced by commit

  93ea4a0b8fce ("Documentation: proc.rst: add more about the 6 fields in loadavg")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 381 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/translations/zh_CN/mips/index.rst:5: WARNING: undefined label: index (if the link has no caption the label must precede a section header)

Introduced by commit

  b8e724fd7117 ("doc/zh_CN: add mips index.rst translation")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 387 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/translations/zh_CN/mips/booting.rst:5: WARNING: undefined label: booting (if the link has no caption the label must precede a section header)

Introduced by commit

  7fd3954b0c52 ("doc/zh_CN: add mips booting.rst translation")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 1005 bytes --]

Hi all,

On Wed, 13 Jan 2021 15:12:54 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> Documentation/translations/zh_CN/mips/booting.rst:5: WARNING: undefined label: booting (if the link has no caption the label must precede a section header)
> 
> Introduced by commit
> 
>   7fd3954b0c52 ("doc/zh_CN: add mips booting.rst translation")

Similarly,

Documentation/translations/zh_CN/mips/features.rst:5: WARNING: undefined label: features (if the link has no caption the label must precede a section header)

from commit

  72bc9d08868d ("doc/zh_CN: add mips features.rst translation")

and

Documentation/translations/zh_CN/mips/ingenic-tcu.rst:5: WARNING: undefined label: ingenic-tcu (if the link has no caption the label must precede a section header)

from commit

  419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 348 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/nios2/index.rst:7: WARNING: toctree contains reference to nonexisting document 'nios2/features'

Introduced by commit

  ed13a92d0fde ("docs: archis: add a per-architecture features list")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 392 bytes --]

Hi all,

After merging the jc_docs tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/translations/zh_CN/filesystems/tmpfs.rst:5: WARNING: undefined label: tmpfs_index (if the link has no caption the label must precede a section header)

Introduced by commit

  09028e60fcea ("doc: zh_CN: add translatation for tmpfs")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the jc_docs tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 530 bytes --]

Hi all,

On Mon, 16 Nov 2020 17:03:03 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> Documentation/translations/zh_CN/filesystems/tmpfs.rst:5: WARNING: undefined label: tmpfs_index (if the link has no caption the label must precede a section header)
> 
> Introduced by commit
> 
>   09028e60fcea ("doc: zh_CN: add translatation for tmpfs")

I am still getting this warning.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the jc_docs tree

[Jonathan Corbet]

On Tue, 15 Dec 2020 06:51:43 +1100
Stephen Rothwell <sfr@canb.auug.org.au> wrote:

> On Mon, 16 Nov 2020 17:03:03 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
> >
> > After merging the jc_docs tree, today's linux-next build (htmldocs)
> > produced this warning:
> > 
> > Documentation/translations/zh_CN/filesystems/tmpfs.rst:5: WARNING: undefined label: tmpfs_index (if the link has no caption the label must precede a section header)
> > 
> > Introduced by commit
> > 
> >   09028e60fcea ("doc: zh_CN: add translatation for tmpfs")  
> 
> I am still getting this warning.

OK, enough of that; I've just tacked on the following patch to address
this problem, thanks for the report.

Thanks,

jon

From 47e44ed01434e51e2e42b188482d837c01e5d16e Mon Sep 17 00:00:00 2001
From: Jonathan Corbet <corbet@lwn.net>
Date: Mon, 14 Dec 2020 13:14:22 -0700
Subject: [PATCH] docs: fix broken cross reference in translations/zh_CN

Commit 09028e60fcea ("doc: zh_CN: add translatation for tmpfs") introduced
a cross reference without adding the appropriate target tag, leading to
this docs-build warning:

  Documentation/translations/zh_CN/filesystems/tmpfs.rst:5: WARNING: undefined label: tmpfs_index (if the link has no caption the label must precede a section header)

With automarkup, we don't actually need an explicit reference here at all,
so just take it out.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: 09028e60fcea ("doc: zh_CN: add translatation for tmpfs")
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/translations/zh_CN/filesystems/tmpfs.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/translations/zh_CN/filesystems/tmpfs.rst b/Documentation/translations/zh_CN/filesystems/tmpfs.rst
index cf3ccab20e50..6fd9d83b2db5 100644
--- a/Documentation/translations/zh_CN/filesystems/tmpfs.rst
+++ b/Documentation/translations/zh_CN/filesystems/tmpfs.rst
@@ -2,7 +2,7 @@
 
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: :ref:`Documentation/filesystems/tmpfs.rst <tmpfs_index>`
+:Original: Documentation/filesystems/tmpfs.rst
 
 translated by Wang Qing<wangqing@vivo.com>
 
-- 
2.28.0