Re: htmldocs: Documentation/driver-api/tty/tty_port.rst:65: WARNING: Document or section may not begin with a transition. [docutils]

[Randy Dunlap]

Hi k.t.r.,

On 2/2/26 11:45 AM, kernel test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head:   18f7fcd5e69a04df57b563360b88be72471d6b62
> commit: 00d95fcc4dee66dfb6980de6f2973b32f973a1eb docs: kdoc: handle the obsolescensce of docutils.ErrorString()
> date:   5 months ago
> reproduce: (https://download.01.org/0day-ci/archive/20260202/202602022007.fALe9bGB-lkp@xxxxxxxxx/reproduce)

I cannot reproduce this warning.
What version of docutils do you use?

> 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@xxxxxxxxx>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202602022007.fALe9bGB-lkp@xxxxxxxxx/
> 
> All warnings (new ones prefixed by >>):
> 
>    WARNING: No kernel-doc for file ./include/linux/tty_port.h
>    ERROR: Cannot find file ./include/linux/tty_port.h
>    WARNING: No kernel-doc for file ./include/linux/tty_port.h
>    ERROR: Cannot find file ./include/linux/tty_port.h
>    WARNING: No kernel-doc for file ./include/linux/tty_port.h
>>> Documentation/driver-api/tty/tty_port.rst:65: WARNING: Document or section may not begin with a transition. [docutils]
>    ERROR: Cannot find file ./include/linux/tty.h
>    WARNING: No kernel-doc for file ./include/linux/tty.h
>    ERROR: Cannot find file ./include/linux/tty.h
>    WARNING: No kernel-doc for file ./include/linux/tty.h
>    ERROR: Cannot find file ./include/linux/tty.h
> 
> 
> vim +65 Documentation/driver-api/tty/tty_port.rst
> 
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26  61  
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26  62  .. kernel-doc:: include/linux/tty_port.h
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26  63     :identifiers: tty_port
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26  64  
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26 @65  ----
> 3f19fed8d0daed Documentation/tty/tty_port.rst Jiri Slaby 2021-11-26  66  
> 
> :::::: The code at line 65 was first introduced by commit
> :::::: 3f19fed8d0daed6e0e04b130d203d4333b757901 Documentation: add TTY chapter
> 
> :::::: TO: Jiri Slaby <jslaby@xxxxxxx>
> :::::: CC: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> 

thanks.
-- 
~Randy