[lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[kernel test robot]

tree:   git://git.lwn.net/linux.git docs-next
head:   db6b8b9bafa741faaf174751e3342a64483b8039
commit: 4f0145e9ea41cc5d0f80b79a60ce39757d3b47d6 [37/72] docs/zh_CN: Add how-to of Chinese translation
reproduce: (https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202505160627.WtzIIpL6-lkp@intel.com/

All warnings (new ones prefixed by >>):

   Warning: Documentation/hwmon/g762.rst references a file that doesn't exist: Documentation/devicetree/bindings/hwmon/g762.txt
   Warning: Documentation/translations/ja_JP/SubmittingPatches references a file that doesn't exist: linux-2.6.12-vanilla/Documentation/dontdiff
   Warning: Documentation/translations/ja_JP/process/submit-checklist.rst references a file that doesn't exist: Documentation/translations/ja_JP/SubmitChecklist
   Warning: Documentation/translations/zh_CN/admin-guide/README.rst references a file that doesn't exist: Documentation/dev-tools/kgdb.rst
   Warning: Documentation/translations/zh_CN/dev-tools/gdb-kernel-debugging.rst references a file that doesn't exist: Documentation/dev-tools/gdb-kernel-debugging.rst
>> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
   Warning: Documentation/translations/zh_TW/admin-guide/README.rst references a file that doesn't exist: Documentation/dev-tools/kgdb.rst
   Warning: Documentation/translations/zh_TW/dev-tools/gdb-kernel-debugging.rst references a file that doesn't exist: Documentation/dev-tools/gdb-kernel-debugging.rst
   Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/leds/backlight/ti,lp8864.yaml
   Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 984.
   make[2]: *** [Documentation/Makefile:121: htmldocs] Error 255

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Yanteng Si]

Hi robot,

在 5/16/25 7:04 AM, kernel test robot 写道:
> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

I didn't reproduce this warning locally. It seems to be a difference

between different versions of Sphinx.

Could you please provide your Sphinx version?

^^^^^^^^^^^^^^^^^

+译文格式要求
+------------
+
+    - 每行长度最多不超过40个字符
+    - 每行长度请保持一致
+    - 标题的下划线长度请按照一个英文一个字符、一个中文两个字符与标题对齐
+    - 其它的修饰符请与英文文档保持一致
+
+此外在译文的头部，您需要插入以下内容::
+
+    .. SPDX-License-Identifier: GPL-2.0
+    .. include:: ../disclaimer-zh_CN.rst  #您需要了解该文件的路径，根
+                        据您实际翻译的文档灵活调整
+
+    :Original: Documentation/xxx/xxx.rst  #替换为您翻译的英文文档路径
+
+    :翻译:
+
+     司延腾 Yanteng Si <si.yanteng@linux.dev> #替换为您自己的联系方式
+
+翻译技巧
+--------
+
+中文文档有每行40字符限制，因为一个中文字符等于2个英文字符。但是社区并没有

^^^^^^^^^^^^^^^^^^^


I think my grammar is fine. Does anyone know what's going on?


Thanks,

Yanteng

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Alex Shi]

Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
>
> Hi robot,
>
> 在 5/16/25 7:04 AM, kernel test robot 写道:
> > Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
>
> I didn't reproduce this warning locally. It seems to be a difference
>
> between different versions of Sphinx.
>
> Could you please provide your Sphinx version?


I can't reproduce it too. My sphinx tools version is 7.2.6.
And it looks like a incorrect warnning.

Alex

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Philip Li]

On Mon, May 19, 2025 at 10:24:20AM +0800, Alex Shi wrote:
> Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
> >
> > Hi robot,
> >
> > 在 5/16/25 7:04 AM, kernel test robot 写道:
> > > Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
> >
> > I didn't reproduce this warning locally. It seems to be a difference
> >
> > between different versions of Sphinx.
> >
> > Could you please provide your Sphinx version?
> 
> 
> I can't reproduce it too. My sphinx tools version is 7.2.6.
> And it looks like a incorrect warnning.

Sorry for late response, the Sphinx version the bot use is 2.4.4, and it also enables
kconfigs like CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS,
refer to [1] for detail. Hope this is useful.

[1] https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce

> 
> Alex
> 

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Randy Dunlap]

On 5/18/25 8:11 PM, Philip Li wrote:
> On Mon, May 19, 2025 at 10:24:20AM +0800, Alex Shi wrote:
>> Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
>>>
>>> Hi robot,
>>>
>>> 在 5/16/25 7:04 AM, kernel test robot 写道:
>>>> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
>>>
>>> I didn't reproduce this warning locally. It seems to be a difference
>>>
>>> between different versions of Sphinx.
>>>
>>> Could you please provide your Sphinx version?
>>
>>
>> I can't reproduce it too. My sphinx tools version is 7.2.6.
>> And it looks like a incorrect warnning.
> 
> Sorry for late response, the Sphinx version the bot use is 2.4.4, and it also enables

JFYI, Documentation/Changes says that the minimal Sphinx version is 3.4.3.


> kconfigs like CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS,
> refer to [1] for detail. Hope this is useful.
> 
> [1] https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce
> 
>>
>> Alex
>>
> 

-- 
~Randy

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Dongliang Mu]

On Mon, May 19, 2025 at 11:35 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
>
>
> On 5/18/25 8:11 PM, Philip Li wrote:
> > On Mon, May 19, 2025 at 10:24:20AM +0800, Alex Shi wrote:
> >> Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
> >>>
> >>> Hi robot,
> >>>
> >>> 在 5/16/25 7:04 AM, kernel test robot 写道:
> >>>> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
> >>>
> >>> I didn't reproduce this warning locally. It seems to be a difference
> >>>
> >>> between different versions of Sphinx.
> >>>
> >>> Could you please provide your Sphinx version?
> >>
> >>
> >> I can't reproduce it too. My sphinx tools version is 7.2.6.
> >> And it looks like a incorrect warnning.
> >
> > Sorry for late response, the Sphinx version the bot use is 2.4.4, and it also enables
>
> JFYI, Documentation/Changes says that the minimal Sphinx version is 3.4.3.

$ make htmldocs
ERROR: Sphinx version is 1.8.5. It should be >= 3.4.3
Detected OS: Ubuntu 20.04.6 LTS.
Sphinx version: 1.8.5

To upgrade Sphinx, use:

/usr/bin/python3 -m venv sphinx_latest
. sphinx_latest/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt

    If you want to exit the virtualenv, you can use:
deactivate

2) As a package with:

sudo apt-get install python3-sphinx

    Please note that Sphinx >= 3.0 will currently produce false-positive
   warning when the same name is used for more than one type (functions,
   structs, enums,...). This is known Sphinx bug. For more details, see:
https://github.com/sphinx-doc/sphinx/pull/8313

All optional dependencies are met.
Can't build as 1 mandatory dependency is missing at
./scripts/sphinx-pre-install line 984.

For older versions, you will encounter the above error.

>
>
> > kconfigs like CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS,
> > refer to [1] for detail. Hope this is useful.
> >
> > [1] https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce
> >
> >>
> >> Alex
> >>
> >
>
> --
> ~Randy
>
>

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Philip Li]

On Mon, May 19, 2025 at 11:57:12AM +0800, Dongliang Mu wrote:
> On Mon, May 19, 2025 at 11:35 AM Randy Dunlap <rdunlap@infradead.org> wrote:
> >
> >
> >
> > On 5/18/25 8:11 PM, Philip Li wrote:
> > > On Mon, May 19, 2025 at 10:24:20AM +0800, Alex Shi wrote:
> > >> Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
> > >>>
> > >>> Hi robot,
> > >>>
> > >>> 在 5/16/25 7:04 AM, kernel test robot 写道:
> > >>>> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
> > >>>
> > >>> I didn't reproduce this warning locally. It seems to be a difference
> > >>>
> > >>> between different versions of Sphinx.
> > >>>
> > >>> Could you please provide your Sphinx version?
> > >>
> > >>
> > >> I can't reproduce it too. My sphinx tools version is 7.2.6.
> > >> And it looks like a incorrect warnning.
> > >
> > > Sorry for late response, the Sphinx version the bot use is 2.4.4, and it also enables
> >
> > JFYI, Documentation/Changes says that the minimal Sphinx version is 3.4.3.
> 
> $ make htmldocs
> ERROR: Sphinx version is 1.8.5. It should be >= 3.4.3
> Detected OS: Ubuntu 20.04.6 LTS.
> Sphinx version: 1.8.5
> 
> To upgrade Sphinx, use:
> 
> /usr/bin/python3 -m venv sphinx_latest
> . sphinx_latest/bin/activate
> pip install -r ./Documentation/sphinx/requirements.txt
> 
>     If you want to exit the virtualenv, you can use:
> deactivate
> 
> 2) As a package with:
> 
> sudo apt-get install python3-sphinx
> 
>     Please note that Sphinx >= 3.0 will currently produce false-positive
>    warning when the same name is used for more than one type (functions,
>    structs, enums,...). This is known Sphinx bug. For more details, see:
> https://github.com/sphinx-doc/sphinx/pull/8313
> 
> All optional dependencies are met.
> Can't build as 1 mandatory dependency is missing at
> ./scripts/sphinx-pre-install line 984.
> 
> For older versions, you will encounter the above error.

Got it, thanks for detail info, i will resolve the issue to
upgrade the tool chain at bot side.

> 
> >
> >
> > > kconfigs like CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS,
> > > refer to [1] for detail. Hope this is useful.
> > >
> > > [1] https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce
> > >
> > >>
> > >> Alex
> > >>
> > >
> >
> > --
> > ~Randy
> >
> >

Re: [lwn:docs-next 37/72] htmldocs: Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst

[Philip Li]

On Sun, May 18, 2025 at 08:34:54PM -0700, Randy Dunlap wrote:
> 
> 
> On 5/18/25 8:11 PM, Philip Li wrote:
> > On Mon, May 19, 2025 at 10:24:20AM +0800, Alex Shi wrote:
> >> Yanteng Si <si.yanteng@linux.dev> 于2025年5月16日周五 18:02写道：
> >>>
> >>> Hi robot,
> >>>
> >>> 在 5/16/25 7:04 AM, kernel test robot 写道:
> >>>> Warning: Documentation/translations/zh_CN/how-to.rst references a file that doesn't exist: Documentation/xxx/xxx.rst
> >>>
> >>> I didn't reproduce this warning locally. It seems to be a difference
> >>>
> >>> between different versions of Sphinx.
> >>>
> >>> Could you please provide your Sphinx version?
> >>
> >>
> >> I can't reproduce it too. My sphinx tools version is 7.2.6.
> >> And it looks like a incorrect warnning.
> > 
> > Sorry for late response, the Sphinx version the bot use is 2.4.4, and it also enables
> 
> JFYI, Documentation/Changes says that the minimal Sphinx version is 3.4.3.

Got it, thanks for the info, i will fix the bot to avoid the false report.

> 
> 
> > kconfigs like CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS,
> > refer to [1] for detail. Hope this is useful.
> > 
> > [1] https://download.01.org/0day-ci/archive/20250516/202505160627.WtzIIpL6-lkp@intel.com/reproduce
> > 
> >>
> >> Alex
> >>
> > 
> 
> -- 
> ~Randy
>