From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: [PATCH 07/11] docs: misc-devices/pci-endpoint-test.txt: convert to ReST
Date: Thu, 6 Feb 2020 16:11:26 +0100 [thread overview]
Message-ID: <fb0bc693ebb7eaad36b76c87cd58c91453872cf0.1581001737.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1581001737.git.mchehab+huawei@kernel.org>
- use title markups;
- mark literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../{ad525x_dpot.txt => ad525x_dpot.rst} | 24 +++++++++----------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 13 insertions(+), 12 deletions(-)
rename Documentation/misc-devices/{ad525x_dpot.txt => ad525x_dpot.rst} (85%)
diff --git a/Documentation/misc-devices/ad525x_dpot.txt b/Documentation/misc-devices/ad525x_dpot.rst
similarity index 85%
rename from Documentation/misc-devices/ad525x_dpot.txt
rename to Documentation/misc-devices/ad525x_dpot.rst
index 0c9413b1cbf3..6483ec254520 100644
--- a/Documentation/misc-devices/ad525x_dpot.txt
+++ b/Documentation/misc-devices/ad525x_dpot.rst
@@ -1,6 +1,8 @@
----------------------------------
- AD525x Digital Potentiometers
----------------------------------
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================
+AD525x Digital Potentiometers
+=============================
The ad525x_dpot driver exports a simple sysfs interface. This allows you to
work with the immediate resistance settings as well as update the saved startup
@@ -8,9 +10,8 @@ settings. Access to the factory programmed tolerance is also provided, but
interpretation of this settings is required by the end application according to
the specific part in use.
----------
- Files
----------
+Files
+=====
Each dpot device will have a set of eeprom, rdac, and tolerance files. How
many depends on the actual part you have, as will the range of allowed values.
@@ -24,23 +25,22 @@ and may vary greatly on a part-by-part basis. For exact interpretation of
this field, please consult the datasheet for your part. This is presented
as a hex file for easier parsing.
------------
- Example
------------
+Example
+=======
Locate the device in your sysfs tree. This is probably easiest by going into
-the common i2c directory and locating the device by the i2c slave address.
+the common i2c directory and locating the device by the i2c slave address::
# ls /sys/bus/i2c/devices/
0-0022 0-0027 0-002f
So assuming the device in question is on the first i2c bus and has the slave
-address of 0x2f, we descend (unrelated sysfs entries have been trimmed).
+address of 0x2f, we descend (unrelated sysfs entries have been trimmed)::
# ls /sys/bus/i2c/devices/0-002f/
eeprom0 rdac0 tolerance0
-You can use simple reads/writes to access these files:
+You can use simple reads/writes to access these files::
# cd /sys/bus/i2c/devices/0-002f/
diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 2d454b413aef..005547c1ad5d 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -14,6 +14,7 @@ fit into other categories.
.. toctree::
:maxdepth: 2
+ ad525x_dpot
eeprom
ibmvmc
ics932s401
--
2.24.1
next prev parent reply other threads:[~2020-02-06 15:11 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-06 15:11 [PATCH 00/11] Manually convert thermal, crypto and misc-devices to ReST Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 01/11] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 02/11] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-02-06 20:09 ` Ben Boeckel
2020-02-10 6:10 ` Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 03/11] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 04/11] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 05/11] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 06/11] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-02-06 15:11 ` Mauro Carvalho Chehab [this message]
2020-02-06 15:11 ` [PATCH 08/11] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 09/11] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 10/11] docs: misc-devices/bh1770glc.txt: convert to ReST Mauro Carvalho Chehab
2020-02-06 15:11 ` [PATCH 11/11] docs: misc-devices/apds990x.txt: convert to ReST format Mauro Carvalho Chehab
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=fb0bc693ebb7eaad36b76c87cd58c91453872cf0.1581001737.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@infradead.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).