linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux ARM <linux-arm-kernel@lists.infradead.org>,
	Devicetree <devicetree@vger.kernel.org>
Cc: Souradeep Chowdhury <quic_schowdhu@quicinc.com>,
	Alex Elder <elder@linaro.org>,
	Bjorn Andersson <andersson@kernel.org>,
	Andy Gross <agross@kernel.org>,
	Konrad Dybcio <konrad.dybcio@somainline.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Rob Herring <robh+dt@kernel.org>,
	Sai Prakash Ranjan <quic_saipraka@quicinc.com>,
	Sibi Sankar <quic_sibis@quicinc.com>,
	Rajendra Nayak <quic_rjendra@quicinc.com>,
	Vinod Koul <vkoul@kernel.org>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	kernel test robot <lkp@intel.com>
Subject: [PATCH 1/2] soc: qcom: dcc: Fix examples list on /sys/kernel/debug/dcc/.../[list-number]/config documentation
Date: Fri, 30 Dec 2022 20:50:30 +0700	[thread overview]
Message-ID: <20221230135030.17002-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20221230135030.17002-1-bagasdotme@gmail.com>

kernel test robot reported htmldocs warnings:

Documentation/ABI/testing/debugfs-driver-dcc:34: WARNING: Unexpected indentation.
Documentation/ABI/testing/debugfs-driver-dcc:34: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix these by fixing numbered list syntax on description of
/sys/kernel/debug/dcc/.../[list-number]/config, including adding blank line
separators as appropriate.

Link: https://lore.kernel.org/linux-doc/202212300426.eMLsZsvA-lkp@intel.com/
Fixes: 4cbe60cf5ad622 ("soc: qcom: dcc: Add driver support for Data Capture and Compare unit(DCC)")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/ABI/testing/debugfs-driver-dcc | 63 +++++++++++++-------
 1 file changed, 41 insertions(+), 22 deletions(-)

diff --git a/Documentation/ABI/testing/debugfs-driver-dcc b/Documentation/ABI/testing/debugfs-driver-dcc
index a4680950205931..a00f4502885b58 100644
--- a/Documentation/ABI/testing/debugfs-driver-dcc
+++ b/Documentation/ABI/testing/debugfs-driver-dcc
@@ -44,35 +44,54 @@ Description:
 		example user can jump to list x only after list y is
 		configured and enabled. The format for entering all
 		types of instructions are explained in examples as
-		follows.
-		Example:
-	         i)Read Type Instruction
+		follows:
+
+	        i) Read Type Instruction
+
 		   echo R <1> <2> <3> >/sys/kernel/debug/dcc/../[list-number]/config
+
 		   1->Address to be considered for reading the value.
+
 		   2->The word count of the addresses, read n words
 		      starting from address <1>. Each word is of 32 bits.
 		      If not entered 1 is considered.
+
 		   3->Can be 'apb' or 'ahb' which indicates if it is apb or ahb
 		      bus respectively. If not entered ahb is considered.
-		ii)Write Type Instruction
-		   echo W <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
-		   1->Address to be considered for writing the value.
-		   2->The value that needs to be written at the location.
-		   3->Can be a 'apb' or 'ahb' which indicates if it is apb or ahb
-		      but respectively.
-	       iii)Read Modify Write type instruction
-		   echo RW <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
-		   1->The address which needs to be considered for read then write.
-		   2->The value that needs to be written on the address.
-		   3->The mask of the value to be written.
-		iv)Loop Type Instruction
-		   echo L <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
-		   1->The loop count, the number of times the value of the addresses will be
-		      captured.
-		   2->The address count, total number of addresses to be entered in this
-		      instruction.
-		   3->The series of addresses to be entered separated by a space like <addr1>
-		      <addr2>... and so on.
+
+		ii) Write Type Instruction
+
+		    echo W <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
+
+		    1->Address to be considered for writing the value.
+
+		    2->The value that needs to be written at the location.
+
+		    3->Can be a 'apb' or 'ahb' which indicates if it is apb or ahb
+		       but respectively.
+
+	        iii) Read Modify Write type instruction
+
+		     echo RW <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
+
+		     1->The address which needs to be considered for read then write.
+
+		     2->The value that needs to be written on the address.
+
+		     3->The mask of the value to be written.
+
+		iv) Loop Type Instruction
+
+		    echo L <1> <2> <3> > /sys/kernel/debug/dcc/../[list-number]/config
+
+		    1->The loop count, the number of times the value of the addresses will be
+		       captured.
+
+		    2->The address count, total number of addresses to be entered in this
+		       instruction.
+
+		    3->The series of addresses to be entered separated by a space like <addr1>
+		       <addr2>... and so on.
 
 What:           /sys/kernel/debug/dcc/.../[list-number]/enable
 Date:           December 2022
-- 
An old man doll... just what I always wanted! - Clara


  reply	other threads:[~2022-12-30 13:51 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-30 13:50 [PATCH 0/2] soc: qcom: dcc: Documentation improv Bagas Sanjaya
2022-12-30 13:50 ` Bagas Sanjaya [this message]
2023-01-05  5:04   ` [PATCH 1/2] soc: qcom: dcc: Fix examples list on /sys/kernel/debug/dcc/.../[list-number]/config documentation Souradeep Chowdhury
2022-12-30 13:50 ` [PATCH 2/2] soc: qcom: dcc: rewrite description of dcc sysfs files Bagas Sanjaya
2023-01-05  5:17   ` Souradeep Chowdhury
2023-01-05  3:33 ` [PATCH 0/2] soc: qcom: dcc: Documentation improv Bagas Sanjaya
2023-01-07  0:08 ` Bjorn Andersson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221230135030.17002-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=agross@kernel.org \
    --cc=andersson@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=elder@linaro.org \
    --cc=konrad.dybcio@somainline.org \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lkp@intel.com \
    --cc=quic_rjendra@quicinc.com \
    --cc=quic_saipraka@quicinc.com \
    --cc=quic_schowdhu@quicinc.com \
    --cc=quic_sibis@quicinc.com \
    --cc=robh+dt@kernel.org \
    --cc=vkoul@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).