docs: misc-devices/bh1770glc.txt: convert to ReST

- Adjust document title markup;
- use list markups;
- Adjust identations to display properly at ReST output.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/58ba712524318d03b3196bba33cb409472b4807d.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/Documentation/misc-devices/bh1770glc.txt b/Documentation/misc-devices/bh1770glc.rst
similarity index 83%
rename from Documentation/misc-devices/bh1770glc.txt
rename to Documentation/misc-devices/bh1770glc.rst
index 7d64c014dc70a4a7420036353012b4b62b422b56..ea5ca58bb958512d9bb5c8265882ee5e373f5666 100644 (file)
--- a/Documentation/misc-devices/bh1770glc.txt
+++ b/Documentation/misc-devices/bh1770glc.rst
@@ -1,9 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================
 Kernel driver bh1770glc
 =======================
 
 Supported chips:
-ROHM BH1770GLC
-OSRAM SFH7770
+
+- ROHM BH1770GLC
+- OSRAM SFH7770
 
 Data sheet:
 Not freely available
@@ -48,12 +52,16 @@ chip_id
        RO - shows detected chip type and version
 
 power_state
-       RW - enable / disable chip. Uses counting logic
-            1 enables the chip
-            0 disables the chip
+       RW - enable / disable chip
+
+       Uses counting logic
+
+            - 1 enables the chip
+            - 0 disables the chip
 
 lux0_input
        RO - measured lux value
+
             sysfs_notify called when threshold interrupt occurs
 
 lux0_sensor_range
@@ -66,16 +74,22 @@ lux0_rate_avail
        RO - supported measurement rates
 
 lux0_thresh_above_value
-       RW - HI level threshold value. All results above the value
+       RW - HI level threshold value
+
+            All results above the value
             trigs an interrupt. 65535 (i.e. sensor_range) disables the above
             interrupt.
 
 lux0_thresh_below_value
-       RW - LO level threshold value. All results below the value
+       RW - LO level threshold value
+
+            All results below the value
             trigs an interrupt. 0 disables the below interrupt.
 
 lux0_calibscale
-       RW - calibration value. Set to neutral value by default.
+       RW - calibration value
+
+            Set to neutral value by default.
             Output results are multiplied with calibscale / calibscale_default
             value.
 
@@ -84,32 +98,37 @@ lux0_calibscale_default
 
 prox0_raw
        RO - measured proximity value
+
             sysfs_notify called when threshold interrupt occurs
 
 prox0_sensor_range
        RO - prox0_raw max value
 
 prox0_raw_en
-       RW - enable / disable proximity - uses counting logic
-            1 enables the proximity
-            0 disables the proximity
+       RW - enable / disable proximity
+
+            Uses counting logic
+
+            - 1 enables the proximity
+            - 0 disables the proximity
 
 prox0_thresh_above_count
        RW - number of proximity interrupts needed before triggering the event
 
 prox0_rate_above
        RW - Measurement rate (in Hz) when the level is above threshold
-            i.e. when proximity on has been reported.
+       i.e. when proximity on has been reported.
 
 prox0_rate_below
        RW - Measurement rate (in Hz) when the level is below threshold
-            i.e. when proximity off has been reported.
+       i.e. when proximity off has been reported.
 
 prox0_rate_avail
        RO - Supported proximity measurement rates in Hz
 
 prox0_thresh_above0_value
        RW - threshold level which trigs proximity events.
+
             Filtered by persistence filter (prox0_thresh_above_count)
 
 prox0_thresh_above1_value

diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 27e268805067ad316b4e600bad1dc0df04e46dca..edf66b59f2d4b613a4e9ed9cbcacc4e38556a3a2 100644 (file)
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -15,6 +15,7 @@ fit into other categories.
    :maxdepth: 2
 
    ad525x_dpot
+   bh1770glc
    eeprom
    c2port
    ibmvmc