git: 10ffe0f957a7 - main - ow_temp.4: improve HARDWARE + tag SPDX
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 26 Nov 2024 18:30:04 UTC
The branch main has been updated by mhorne:
URL: https://cgit.FreeBSD.org/src/commit/?id=10ffe0f957a7dbe48f2cee3b00abcf7fabf41c7d
commit 10ffe0f957a7dbe48f2cee3b00abcf7fabf41c7d
Author: Alexander Ziaee <concussious@runbox.com>
AuthorDate: 2024-11-26 17:26:15 +0000
Commit: Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2024-11-26 18:29:46 +0000
ow_temp.4: improve HARDWARE + tag SPDX
Rewrite the hardware support list to a column list for inclusion in the
Hardware Release Notes. This makes clean subsections. Tested in
MANWIDTH 59 and 80. While here, align sysctl list and tag spdx.
Reviewed by: mhorne
MFC after: 3 days
Differential Revision: https://reviews.freebsd.org/D47707
---
share/man/man4/ow_temp.4 | 31 ++++++++++++++-----------------
1 file changed, 14 insertions(+), 17 deletions(-)
diff --git a/share/man/man4/ow_temp.4 b/share/man/man4/ow_temp.4
index f3fd0f488f43..aa92a12103a8 100644
--- a/share/man/man4/ow_temp.4
+++ b/share/man/man4/ow_temp.4
@@ -1,3 +1,5 @@
+.\"-
+.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2015 M. Warner Losh <imp@FreeBSD.org>
.\"
@@ -21,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd July 20, 2015
+.Dd November 22, 2024
.Dt OW_TEMP 4
.Os
.Sh NAME
@@ -38,22 +40,17 @@ The sensor is read periodically and the results returned via a
.Xr sysctl 3
as described below.
.Sh HARDWARE
-These temperature sensors are supported by the
+The
.Nm
-driver:
-.Bl -tag -width MAX31820 -compact
-.It DS1820
-1-Wire Digital Thermometer
-.It DS18S20
-High-Precision 1-Wire Digital Thermometer
-.It DS18B20
-Programmable Resolution 1-Wire Digital Thermometer
-.It DS1822
-Econo 1-Wire Digital Thermometer
-.It DS1825
-Programmable Resolution 1-Wire Digital Thermometer with 4-bit ID
-.It MAX31820
-1-Wire, Parasite-Power, Ambient Temperature Sensor
+driver supports the following temperature sensors:
+.Pp
+.Bl -column "DS18S20" "Econo 1-Wire Digital Thermometer" -compact
+.It DS1820 Ta 1-Wire Digital Thermometer
+.It DS18S20 Ta High-Precision 1-Wire Digital Thermometer
+.It DS18B20 Ta Programmable Resolution 1-Wire Digital Thermometer
+.It DS1822 Ta Econo 1-Wire Digital Thermometer
+.It DS1825 Ta Programmable Resolution 1-Wire Digital Thermometer with 4-bit ID
+.It MAX31820 Ta 1-Wire, Parasite-Power, Ambient Temperature Sensor
.El
.Pp
The driver supports Family codes 0x10, 0x22, 0x28, and 0x3b.
@@ -65,7 +62,7 @@ driver reports data via
entries in the device's node in the
.Xr sysctl 8
tree:
-.Bl -tag -width xxxxxxxxxx
+.Bl -tag -width "reading_interval"
.It temperature
The last temperature read, in milli-Kelvin.
.It badcrc