OSDN Git Service

docs: misc-devices/pci-endpoint-test.txt: convert to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 15 Jun 2020 06:50:13 +0000 (08:50 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 19 Jun 2020 20:05:49 +0000 (14:05 -0600)
- use title markups;
- mark literal blocks.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/1b1f4e5e57fd2065828cecc9d07afbd247349e94.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/misc-devices/ad525x_dpot.rst [moved from Documentation/misc-devices/ad525x_dpot.txt with 85% similarity]
Documentation/misc-devices/index.rst
drivers/misc/Kconfig
drivers/misc/ad525x_dpot.c

similarity index 85%
rename from Documentation/misc-devices/ad525x_dpot.txt
rename to Documentation/misc-devices/ad525x_dpot.rst
index 0c9413b..6483ec2 100644 (file)
@@ -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/
 
index 56fc1e0..d05626d 100644 (file)
@@ -14,6 +14,7 @@ fit into other categories.
 .. toctree::
    :maxdepth: 2
 
+   ad525x_dpot
    eeprom
    ibmvmc
    ics932s401
index e1b1ba5..3ca4325 100644 (file)
@@ -24,7 +24,7 @@ config AD525X_DPOT
          AD5271, AD5272, AD5274
          digital potentiometer chips.
 
-         See Documentation/misc-devices/ad525x_dpot.txt for the
+         See Documentation/misc-devices/ad525x_dpot.rst for the
          userspace interface.
 
          This driver can also be built as a module.  If so, the module
index ccce322..6f16452 100644 (file)
@@ -58,7 +58,7 @@
  * AD5272              1               1024            20, 50, 100 (50-TP)
  * AD5274              1               256             20, 50, 100 (50-TP)
  *
- * See Documentation/misc-devices/ad525x_dpot.txt for more info.
+ * See Documentation/misc-devices/ad525x_dpot.rst for more info.
  *
  * derived from ad5258.c
  * Copyright (c) 2009 Cyber Switching, Inc.