]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
Merge tag 'docs-6.18' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Sat, 4 Oct 2025 00:16:13 +0000 (17:16 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Sat, 4 Oct 2025 00:16:13 +0000 (17:16 -0700)
Pull documentation updates from Jonathan Corbet:
 "It has been a relatively busy cycle in docsland, with changes all
  over:

   - Bring the kernel memory-model docs into the Sphinx build in the
     "literal include" mode.

   - Lots of build-infrastructure work, further cleaning up long-term
     kernel-doc technical debt. The sphinx-pre-install tool has been
     converted to Python and updated for current systems.

   - A new tool to detect when documents have been moved and generate
     HTML redirects; this can be used on kernel.org (or any other site
     hosting the rendered docs) to avoid breaking links.

   - Automated processing of the YAML files describing the netlink
     protocol.

   - A significant update of the maintainer's PGP guide.

  ... and a seemingly endless series of typo fixes, build-problem fixes,
  etc"

* tag 'docs-6.18' of git://git.lwn.net/linux: (193 commits)
  Documentation/features: Update feature lists for 6.17-rc7
  docs: remove cdomain.py
  Documentation/process: submitting-patches: fix typo in "were do"
  docs: dev-tools/lkmm: Fix typo of missing file extension
  Documentation: trace: histogram: Convert ftrace docs cross-reference
  Documentation: trace: histogram-design: Wrap introductory note in note:: directive
  Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram
  Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text
  Documentation: trace: histogram: Fix histogram trigger subsection number order
  docs: driver-api: fix spelling of "buses".
  Documentation: fbcon: Use admonition directives
  Documentation: fbcon: Reindent 8th step of attach/detach/unload
  Documentation: fbcon: Add boot options and attach/detach/unload section headings
  docs: filesystems: sysfs: add remaining top level sysfs directory descriptions
  docs: filesystems: sysfs: clarify symlink destinations in dev and bus/devices descriptions
  docs: filesystems: sysfs: remove top level sysfs net directory
  docs: maintainer: Fix ambiguous subheading formatting
  docs: kdoc: a few more dump_typedef() tweaks
  docs: kdoc: remove redundant comment stripping in dump_typedef()
  docs: kdoc: remove some dead code in dump_typedef()
  ...

14 files changed:
1  2 
Documentation/admin-guide/kernel-parameters.txt
Documentation/admin-guide/md.rst
Documentation/admin-guide/mm/damon/usage.rst
Documentation/admin-guide/perf/hisi-pmu.rst
Documentation/devicetree/bindings/submitting-patches.rst
Documentation/driver-api/pin-control.rst
Documentation/filesystems/proc.rst
Documentation/filesystems/resctrl.rst
Documentation/filesystems/sysfs.rst
Documentation/networking/can.rst
Documentation/process/changes.rst
MAINTAINERS
Makefile
fs/btrfs/tree-log.c

Simple merge
index c4c2cbbf88cb82af494c0ce030a216d2d68a9592,721eb1623ca7ebf7073ab2ed32f6d0cc7b734e15..f3d9871906a2dccda05aaca9bc4e1b5a63430a73
@@@ -110,53 -109,9 +110,53 @@@ uring channel. It is 2 bits. Some impor
  - 2'b11: count the events which sent to the uring_ext (MATA) channel;
  - 2'b01: is the same as 2'b11;
  - 2'b10: count the events which sent to the uring (non-MATA) channel;
- - 2'b00: default value, count the events which sent to the both uring and
-   uring_ext channel;
+ - 2'b00: default value, count the events which sent to both uring and
+   uring_ext channels;
  
 +6. ch: NoC PMU supports filtering the event counts of certain transaction
 +channel with this option. The current supported channels are as follows:
 +
 +- 3'b010: Request channel
 +- 3'b100: Snoop channel
 +- 3'b110: Response channel
 +- 3'b111: Data channel
 +
 +7. tt_en: NoC PMU supports counting only transactions that have tracetag set
 +if this option is set. See the 2nd list for more information about tracetag.
 +
 +For HiSilicon uncore PMU v3 whose identifier is 0x40, some uncore PMUs are
 +further divided into parts for finer granularity of tracing, each part has its
 +own dedicated PMU, and all such PMUs together cover the monitoring job of events
 +on particular uncore device. Such PMUs are described in sysfs with name format
 +slightly changed::
 +
 +/sys/bus/event_source/devices/hisi_sccl{X}_<l3c{Y}_{Z}/ddrc{Y}_{Z}/noc{Y}_{Z}>
 +
 +Z is the sub-id, indicating different PMUs for part of hardware device.
 +
 +Usage of most PMUs with different sub-ids are identical. Specially, L3C PMU
 +provides ``ext`` option to allow exploration of even finer granual statistics
 +of L3C PMU.  L3C PMU driver uses that as hint of termination when delivering
 +perf command to hardware:
 +
 +- ext=0: Default, could be used with event names.
 +- ext=1 and ext=2: Must be used with event codes, event names are not supported.
 +
 +An example of perf command could be::
 +
 +  $# perf stat -a -e hisi_sccl0_l3c1_0/rd_spipe/ sleep 5
 +
 +or::
 +
 +  $# perf stat -a -e hisi_sccl0_l3c1_0/event=0x1,ext=1/ sleep 5
 +
 +As above, ``hisi_sccl0_l3c1_0`` locates PMU of Super CPU CLuster 0, L3 cache 1
 +pipe0.
 +
 +First command locates the first part of L3C since ``ext=0`` is implied by
 +default. Second command issues the counting on another part of L3C with the
 +event ``0x1``.
 +
  Users could configure IDs to count data come from specific CCL/ICL, by setting
  srcid_cmd & srcid_msk, and data desitined for specific CCL/ICL by setting
  tgtid_cmd & tgtid_msk. A set bit in srcid_msk/tgtid_msk means the PMU will not
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
diff --cc MAINTAINERS
Simple merge
diff --cc Makefile
Simple merge
Simple merge