Skip to contentSkip to conversation

Documentation: perf: fix kernel-doc warnings in imx-ddr.rst

RFC PATCH In review Daniel W. S. Almeida 2 participants 3 messages Nov 7, 2019 – Nov 12, 2019

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 Documentation: perf: fix kernel-doc warnings in imx-ddr.rst

From: "Daniel W. S. Almeida" <[email protected]>

Unexpected indentation errors were reported due to missing blank lines. Now fixed. No change in content otherwise.

---
 Documentation/admin-guide/perf/imx-ddr.rst | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/admin-guide/perf/imx-ddr.rst +5 -0
index 517a205abad6..75c8b46ba6f9 100644
@@ -18,6 +18,7 @@ The "format" directory describes format of the config (event ID) and config1
 devices/imx8_ddr0/format/. The "events" directory describes the events types
 hardware supported that can be used with perf tool, see /sys/bus/event_source/
 devices/imx8_ddr0/events/.
+
   e.g.::
         perf stat -a -e imx8_ddr0/cycles/ cmd
         perf stat -a -e imx8_ddr0/read/,imx8_ddr0/write/ cmd
@@ -31,16 +32,19 @@ in the driver.
   Filter is defined with two configuration parts:
   --AXI_ID defines AxID matching value.
   --AXI_MASKING defines which bits of AxID are meaningful for the matching.
+
         0:corresponding bit is masked.
         1: corresponding bit is not masked, i.e. used to do the matching.
 
   AXI_ID and AXI_MASKING are mapped on DPCR1 register in performance counter.
   When non-masked bits are matching corresponding AXI_ID bits then counter is
   incremented. Perf counter is incremented if
+
           AxID && AXI_MASKING == AXI_ID && AXI_MASKING
 
   This filter doesn't support filter different AXI ID for axid-read and axid-write
   event at the same time as this filter is shared between counters.
+
   e.g.::
         perf stat -a -e imx8_ddr0/axid-read,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd
         perf stat -a -e imx8_ddr0/axid-write,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd
@@ -48,5 +52,6 @@ in the driver.
   NOTE: axi_mask is inverted in userspace(i.e. set bits are bits to mask), and
   it will be reverted in driver automatically. so that the user can just specify
   axi_id to monitor a specific id, rather than having to specify axi_mask.
+
   e.g.::
         perf stat -a -e imx8_ddr0/axid-read,axi_id=0x12/ cmd, which will monitor ARID=0x12
Signature · 1 line
2.24.0
maintainer
#1 lore raw
Quoted 6 lines · On Thu, 7 Nov 2019 15:57:55 -0300 "Daniel W. S. Almeida"…

From: "Daniel W. S. Almeida" <[email protected]>

Unexpected indentation errors were reported due to missing blank lines. Now fixed. No change in content otherwise.

So this is in no way your fault, but this particular file has been the subject of some merge conflicts in linux-next already, so it's probably
best not to mess with it further at the moment. Could I ask you to
resubmit the patch after the 5.5 merge window?

Thanks,

jon
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#2 lore raw
Quoted 4 lines

So this is in no way your fault, but this particular file has been the subject of some merge conflicts in linux-next already, so it's probably best not to mess with it further at the moment. Could I ask you to resubmit the patch after the 5.5 merge window?

Yes that is fine!
Thanks.

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees