htmldocs: Documentation/trace/ptwrite-uprobes.rst:180: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

[kernel test robot <lkp@intel.com>]

tree:   https://github.com/intel-lab-lkp/linux/commits/Andi-Kleen/ptwrite-uprobes-Add-minimal-low-level-support-for-x86/20260917-160029
head:   d3e06d9b6740df5ab41aab7ef2dd8661f80b774f
commit: 17103df8b292f69d812df6895c842ff3fba63fc0 ptwrite uprobes: Add a tutorial and overview documentation
date:   5 days ago
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)
reproduce: (https://download.01.org/0day-ci/archive/20260923/202609231044.y1IuI9u7-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/202609231044.y1IuI9u7-lkp@intel.com/

All warnings (new ones prefixed by >>):

   Relational referents
   ~~~~~~~~~~~~~~~~~~~~~ [docutils]
>> Documentation/trace/ptwrite-uprobes.rst:180: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:204: ERROR: Unexpected indentation. [docutils]
>> Documentation/trace/ptwrite-uprobes.rst:209: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:212: ERROR: Unexpected indentation. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:214: ERROR: Unexpected indentation. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:216: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:219: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
   Documentation/trace/ptwrite-uprobes.rst:321: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]


vim +180 Documentation/trace/ptwrite-uprobes.rst

   174	
   175	  ptw[:[GRP/][EVENT]] PATH:OFFSET [FETCHARGS] : set a ptwrite probe
   176	  -:[GRP/][EVENT]                             : clear a probe
   177	
   178	  GRP      : group name. If omitted, "uprobes" is the default (the
   179	             event appears under events/uprobes/).
 > 180	  EVENT    : event name. If omitted, one is generated from PATH+OFFSET.
   181	  PATH     : path to an executable or a library.
   182	  OFFSET   : file offset of the probe site (0x-prefixed hex, see above).
   183	  FETCHARGS: probe arguments, up to 8 (see "Argument syntax" below).
   184	
   185	After creating the ptwrite uprobe it becomes available with its name
   186	in ``/sys/kernel/tracing/uprobe_events``. There it can be enabled
   187	by writing 1 to its enable field. However it only logs data
   188	when a Linux perf PT recording session with ptw=1 is active.
   189	
   190	perf probe
   191	----------
   192	
   193	``perf probe --ptwrite -x <file>`` creates ptwrite uprobes instead of
   194	the classic trap-based ones. The example below uses SDT probes.
   195	
   196	(this requires installing systemtap-devel or an equivalent package)
   197	
   198	    $ cat > t.c <<'EOF'
   199	    #include <stdio.h>
   200	    #include <sys/sdt.h>
   201	    __attribute__((noinline, noclone)) static unsigned long
   202	    target(unsigned long a, unsigned long b)
   203	    {
   204	        unsigned long local = a * 2;
   205	        STAP_PROBE1(test, rarg, a);
   206	        STAP_PROBE1(test, carg, 42);
   207	        STAP_PROBE2(test, marg, &local, b);
   208	        return a * 31 + b;
 > 209	    }
   210	    int main(void)
   211	    {
   212	        unsigned long i, acc = 0;
   213	        for (i = 0; i < 20; i++) {
   214	            acc += target(i, i + 1);
   215	            asm volatile("pause");
   216	        }
   217	        printf("acc=%lu\n", acc);
   218	        return 0;
   219	    }
   220	    EOF
   221	    $ gcc -O2 -no-pie -o t t.c
   222	

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