Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: misc-devices/pci-endpoint-test.txt: convert to ReST

- 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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
8a05eb89 3471b9f7

+15 -14
+12 -12
Documentation/misc-devices/ad525x_dpot.txt Documentation/misc-devices/ad525x_dpot.rst
··· 1 - --------------------------------- 2 - AD525x Digital Potentiometers 3 - --------------------------------- 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ============================= 4 + AD525x Digital Potentiometers 5 + ============================= 4 6 5 7 The ad525x_dpot driver exports a simple sysfs interface. This allows you to 6 8 work with the immediate resistance settings as well as update the saved startup ··· 10 8 interpretation of this settings is required by the end application according to 11 9 the specific part in use. 12 10 13 - --------- 14 - Files 15 - --------- 11 + Files 12 + ===== 16 13 17 14 Each dpot device will have a set of eeprom, rdac, and tolerance files. How 18 15 many depends on the actual part you have, as will the range of allowed values. ··· 25 24 this field, please consult the datasheet for your part. This is presented 26 25 as a hex file for easier parsing. 27 26 28 - ----------- 29 - Example 30 - ----------- 27 + Example 28 + ======= 31 29 32 30 Locate the device in your sysfs tree. This is probably easiest by going into 33 - the common i2c directory and locating the device by the i2c slave address. 31 + the common i2c directory and locating the device by the i2c slave address:: 34 32 35 33 # ls /sys/bus/i2c/devices/ 36 34 0-0022 0-0027 0-002f 37 35 38 36 So assuming the device in question is on the first i2c bus and has the slave 39 - address of 0x2f, we descend (unrelated sysfs entries have been trimmed). 37 + address of 0x2f, we descend (unrelated sysfs entries have been trimmed):: 40 38 41 39 # ls /sys/bus/i2c/devices/0-002f/ 42 40 eeprom0 rdac0 tolerance0 43 41 44 - You can use simple reads/writes to access these files: 42 + You can use simple reads/writes to access these files:: 45 43 46 44 # cd /sys/bus/i2c/devices/0-002f/ 47 45
+1
Documentation/misc-devices/index.rst
··· 14 14 .. toctree:: 15 15 :maxdepth: 2 16 16 17 + ad525x_dpot 17 18 eeprom 18 19 ibmvmc 19 20 ics932s401
+1 -1
drivers/misc/Kconfig
··· 24 24 AD5271, AD5272, AD5274 25 25 digital potentiometer chips. 26 26 27 - See Documentation/misc-devices/ad525x_dpot.txt for the 27 + See Documentation/misc-devices/ad525x_dpot.rst for the 28 28 userspace interface. 29 29 30 30 This driver can also be built as a module. If so, the module
+1 -1
drivers/misc/ad525x_dpot.c
··· 58 58 * AD5272 1 1024 20, 50, 100 (50-TP) 59 59 * AD5274 1 256 20, 50, 100 (50-TP) 60 60 * 61 - * See Documentation/misc-devices/ad525x_dpot.txt for more info. 61 + * See Documentation/misc-devices/ad525x_dpot.rst for more info. 62 62 * 63 63 * derived from ad5258.c 64 64 * Copyright (c) 2009 Cyber Switching, Inc.