linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 10/24] docs: misc-devices/bh1770glc.txt: convert to ReST
Date: Mon, 17 Feb 2020 17:20:28 +0100	[thread overview]
Message-ID: <c5dce3a42e336d4d4aa52f22f7ba4ebc6b595dec.1581956285.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1581956285.git.mchehab+huawei@kernel.org>

- 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>
---
 .../{bh1770glc.txt => bh1770glc.rst}          | 45 +++++++++++++------
 Documentation/misc-devices/index.rst          |  1 +
 2 files changed, 33 insertions(+), 13 deletions(-)
 rename Documentation/misc-devices/{bh1770glc.txt => bh1770glc.rst} (83%)

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 7d64c014dc70..ea5ca58bb958 100644
--- 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 c2e880d78734..40a4c104e7a2 100644
--- 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
-- 
2.24.1


  parent reply	other threads:[~2020-02-17 16:20 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 02/24] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 03/24] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 04/24] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 05/24] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 06/24] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 07/24] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 08/24] " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 09/24] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab
2020-02-17 16:20 ` Mauro Carvalho Chehab [this message]
2020-02-17 16:20 ` [PATCH v2 11/24] docs: misc-devices/apds990x.txt: " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 12/24] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST Mauro Carvalho Chehab
2020-02-27 23:03   ` Bjorn Helgaas
2020-02-17 16:20 ` [PATCH v2 13/24] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab
2020-06-02 21:01   ` Rob Herring
2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST Mauro Carvalho Chehab
2020-02-17 20:06   ` Rafael J. Wysocki
2020-02-28  9:14     ` Mauro Carvalho Chehab
2020-02-28  9:33       ` Rafael J. Wysocki
2020-03-02 21:19   ` Jonathan Corbet
2020-03-02 22:16     ` Rafael J. Wysocki
2020-03-03 13:54       ` Mauro Carvalho Chehab
2020-03-03 14:01     ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 16/24] docs: cpu-freq: convert core.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 21/24] docs: powerpc: convert vcpudispatch_stats.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 22/24] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 23/24] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 24/24] docs: trace: ring-buffer-design.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=c5dce3a42e336d4d4aa52f22f7ba4ebc6b595dec.1581956285.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.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).