All of lore.kernel.org
 help / color / mirror / Atom feed
* [sj:damon/next 110/118] htmldocs: Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils]
@ 2026-01-04  8:49 kernel test robot
  2026-01-04 17:57 ` SeongJae Park
  0 siblings, 1 reply; 2+ messages in thread
From: kernel test robot @ 2026-01-04  8:49 UTC (permalink / raw)
  To: SeongJae Park; +Cc: oe-kbuild-all, linux-doc

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/sj/linux.git damon/next
head:   28d3c5e02b31f08aa715cf01ead66c072a9c5d5a
commit: 5ff971ba3599d1e5d6a1721a85d50969a3c270ca [110/118] Docs/admin-guide/mm/damon/usage: suggest use of DAMON modules
reproduce: (https://download.01.org/0day-ci/archive/20260104/202601040942.MWKEmMKA-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/202601040942.MWKEmMKA-lkp@intel.com/

All warnings (new ones prefixed by >>):

   WARNING: No kernel-doc for file ./include/linux/pci.h
   ERROR: Cannot find file ./include/linux/mod_devicetable.h
   WARNING: No kernel-doc for file ./include/linux/mod_devicetable.h
   ERROR: Cannot find file ./include/linux/bootconfig.h
   WARNING: No kernel-doc for file ./include/linux/bootconfig.h
>> Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils]
   ERROR: Cannot find file ./include/linux/pstore_zone.h
   ERROR: Cannot find file ./include/linux/pstore_zone.h
   WARNING: No kernel-doc for file ./include/linux/pstore_zone.h
   ERROR: Cannot find file ./include/linux/pstore_blk.h
   ERROR: Cannot find file ./include/linux/pstore_blk.h


vim +9 Documentation/admin-guide/mm/damon/usage.rst

     8	
   > 9	- *Special-purpose DAMON modules.*
    10	  :ref:`This <damon_modules_special_purpose>`_ is for people who building,
    11	  distributing, and/or administrating the kernel with special-purpose DAMON
    12	  usages.  Using this, users can use DAMON's major features for the given
    13	  purposes in build, boot, or runtime in simple ways.
    14	- *DAMON user space tool.*
    15	  `This <https://github.com/damonitor/damo>`_ is for privileged people such as
    16	  system administrators who want a just-working human-friendly interface.
    17	  Using this, users can use the DAMON’s major features in a human-friendly way.
    18	  It may not be highly tuned for special cases, though.  For more detail,
    19	  please refer to its `usage document
    20	  <https://github.com/damonitor/damo/blob/next/USAGE.md>`_.
    21	- *sysfs interface.*
    22	  :ref:`This <sysfs_interface>` is for privileged user space programmers who
    23	  want more optimized use of DAMON.  Using this, users can use DAMON’s major
    24	  features by reading from and writing to special sysfs files.  Therefore,
    25	  you can write and use your personalized DAMON sysfs wrapper programs that
    26	  reads/writes the sysfs files instead of you.  The `DAMON user space tool
    27	  <https://github.com/damonitor/damo>`_ is one example of such programs.
    28	- *Kernel Space Programming Interface.*
    29	  :doc:`This </mm/damon/api>` is for kernel space programmers.  Using this,
    30	  users can utilize every feature of DAMON most flexibly and efficiently by
    31	  writing kernel space DAMON application programs for you.  You can even extend
    32	  DAMON for various address spaces.  For detail, please refer to the interface
    33	  :doc:`document </mm/damon/api>`.
    34	

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [sj:damon/next 110/118] htmldocs: Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils]
  2026-01-04  8:49 [sj:damon/next 110/118] htmldocs: Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils] kernel test robot
@ 2026-01-04 17:57 ` SeongJae Park
  0 siblings, 0 replies; 2+ messages in thread
From: SeongJae Park @ 2026-01-04 17:57 UTC (permalink / raw)
  To: kernel test robot; +Cc: SeongJae Park, oe-kbuild-all, linux-doc, damon

On Sun, 04 Jan 2026 09:49:08 +0100 kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/sj/linux.git damon/next
> head:   28d3c5e02b31f08aa715cf01ead66c072a9c5d5a
> commit: 5ff971ba3599d1e5d6a1721a85d50969a3c270ca [110/118] Docs/admin-guide/mm/damon/usage: suggest use of DAMON modules
> reproduce: (https://download.01.org/0day-ci/archive/20260104/202601040942.MWKEmMKA-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/202601040942.MWKEmMKA-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
>    WARNING: No kernel-doc for file ./include/linux/pci.h
>    ERROR: Cannot find file ./include/linux/mod_devicetable.h
>    WARNING: No kernel-doc for file ./include/linux/mod_devicetable.h
>    ERROR: Cannot find file ./include/linux/bootconfig.h
>    WARNING: No kernel-doc for file ./include/linux/bootconfig.h
> >> Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils]
>    ERROR: Cannot find file ./include/linux/pstore_zone.h
>    ERROR: Cannot find file ./include/linux/pstore_zone.h
>    WARNING: No kernel-doc for file ./include/linux/pstore_zone.h
>    ERROR: Cannot find file ./include/linux/pstore_blk.h
>    ERROR: Cannot find file ./include/linux/pstore_blk.h

Thank you for this report!

> 
> 
> vim +9 Documentation/admin-guide/mm/damon/usage.rst
> 
>      8	
>    > 9	- *Special-purpose DAMON modules.*
>     10	  :ref:`This <damon_modules_special_purpose>`_ is for people who building,

The '_' at the end of the reference was the problem.  I just pushed a fix to
damon/next tree.


Thanks,
SJ

[...]

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-01-04 17:57 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-01-04  8:49 [sj:damon/next 110/118] htmldocs: Documentation/admin-guide/mm/damon/usage.rst:9: WARNING: Mismatch: both interpreted text role prefix and reference suffix. [docutils] kernel test robot
2026-01-04 17:57 ` SeongJae Park

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.