linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [sj:damon/next 120/121] htmldocs: Documentation/admin-guide/mm/damon/stat.rst:13: WARNING: malformed hyperlink target. [docutils]
@ 2025-10-05 23:45 kernel test robot
  2025-10-06 17:18 ` SeongJae Park
  0 siblings, 1 reply; 2+ messages in thread
From: kernel test robot @ 2025-10-05 23:45 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:   d2a846a38c8b6e1f2473db076998642ea3bac918
commit: 94d350c7971494ad1967e5d04745401a08adbd83 [120/121] Docs/admin-guide/mm/damon/stat: document aggr_interval_us parameter
reproduce: (https://download.01.org/0day-ci/archive/20251006/202510060124.YaUaLfkH-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/202510060124.YaUaLfkH-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/stat.rst:13: WARNING: malformed hyperlink target. [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
--
   ERROR: Cannot find file ./include/linux/mutex.h
   ERROR: Cannot find file ./include/linux/mutex.h
   WARNING: No kernel-doc for file ./include/linux/mutex.h
   ERROR: Cannot find file ./include/linux/fwctl.h
   WARNING: No kernel-doc for file ./include/linux/fwctl.h
>> Documentation/admin-guide/mm/damon/stat.rst:51: WARNING: undefined label: 'damon_stat_monitoring_accuracy_overhead' [ref.ref]


vim +13 Documentation/admin-guide/mm/damon/stat.rst

    12	
  > 13	.. _damon_stat_monitoring_accuracy_overhead
    14	
    15	Monitoring Accuracy and Overhead
    16	================================
    17	
    18	DAMON_STAT uses monitoring intervals :ref:`auto-tuning
    19	<damon_design_monitoring_intervals_autotuning>` to make its accuracy high and
    20	overhead minimum.  It auto-tunes the intervals aiming 4 % of observable access
    21	events to be captured in each snapshot, while limiting the resulting sampling
    22	events to be 5 milliseconds in minimum and 10 seconds in maximum.  On a few
    23	production server systems, it resulted in consuming only 0.x % single CPU time,
    24	while capturing reasonable quality of access patterns.
    25	
    26	Interface: Module Parameters
    27	============================
    28	
    29	To use this feature, you should first ensure your system is running on a kernel
    30	that is built with ``CONFIG_DAMON_STAT=y``.  The feature can be enabled by
    31	default at build time, by setting ``CONFIG_DAMON_STAT_ENABLED_DEFAULT`` true.
    32	
    33	To let sysadmins enable or disable it at boot and/or runtime, and read the
    34	monitoring results, DAMON_STAT provides module parameters.  Following
    35	sections are descriptions of the parameters.
    36	
    37	enabled
    38	-------
    39	
    40	Enable or disable DAMON_STAT.
    41	
    42	You can enable DAMON_STAT by setting the value of this parameter as ``Y``.
    43	Setting it as ``N`` disables DAMON_STAT.  The default value is set by
    44	``CONFIG_DAMON_STAT_ENABLED_DEFAULT`` build config option.
    45	
    46	aggr_interval_us
    47	----------------
    48	
    49	Auto-tuned time interval for the last snapshot in microseconds.
    50	
  > 51	The current aggregation interval of DAMON that :ref:`auto-tuned
    52	<damon_stat_monitoring_accuracy_overhead>`.
    53	

-- 
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 120/121] htmldocs: Documentation/admin-guide/mm/damon/stat.rst:13: WARNING: malformed hyperlink target. [docutils]
  2025-10-05 23:45 [sj:damon/next 120/121] htmldocs: Documentation/admin-guide/mm/damon/stat.rst:13: WARNING: malformed hyperlink target. [docutils] kernel test robot
@ 2025-10-06 17:18 ` SeongJae Park
  0 siblings, 0 replies; 2+ messages in thread
From: SeongJae Park @ 2025-10-06 17:18 UTC (permalink / raw)
  To: kernel test robot; +Cc: SeongJae Park, oe-kbuild-all, linux-doc, damon

On Mon, 6 Oct 2025 01:45:41 +0200 kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/sj/linux.git damon/next
> head:   d2a846a38c8b6e1f2473db076998642ea3bac918
> commit: 94d350c7971494ad1967e5d04745401a08adbd83 [120/121] Docs/admin-guide/mm/damon/stat: document aggr_interval_us parameter
> reproduce: (https://download.01.org/0day-ci/archive/20251006/202510060124.YaUaLfkH-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/202510060124.YaUaLfkH-lkp@intel.com/

Thank you for reporting this!  I just pushed a fix to my tree:
https://git.kernel.org/sj/c/347be1d4cfca4617b44ae692cc67d7903953c542


Thanks,
SJ

[...]

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

end of thread, other threads:[~2025-10-06 17:18 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-05 23:45 [sj:damon/next 120/121] htmldocs: Documentation/admin-guide/mm/damon/stat.rst:13: WARNING: malformed hyperlink target. [docutils] kernel test robot
2025-10-06 17:18 ` SeongJae Park

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).