Module Name: src
Committed By: uwe
Date: Fri Jan 24 03:47:47 UTC 2025
Modified Files:
src/share/man/man4: sht3xtemp.4
Log Message:
sht3xtemp(4): minor markup fixes, new sentence - new line
Also "addr" in the attachment is called "locator" in config(5)
parlance, not "argument".
To generate a diff of this commit:
cvs rdiff -u -r1.4 -r1.5 src/share/man/man4/sht3xtemp.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/sht3xtemp.4
diff -u src/share/man/man4/sht3xtemp.4:1.4 src/share/man/man4/sht3xtemp.4:1.5
--- src/share/man/man4/sht3xtemp.4:1.4 Thu Jan 23 19:14:45 2025
+++ src/share/man/man4/sht3xtemp.4 Fri Jan 24 03:47:47 2025
@@ -1,4 +1,4 @@
-.\" $NetBSD: sht3xtemp.4,v 1.4 2025/01/23 19:14:45 brad Exp $
+.\" $NetBSD: sht3xtemp.4,v 1.5 2025/01/24 03:47:47 uwe Exp $
.\"
.\" Copyright (c) 2021 Brad Spencer <[email protected]>
.\"
@@ -33,18 +33,18 @@ framework.
The
.Nm
.Ar addr
-argument selects the address at the
+locator selects the address at the
.Xr iic 4
bus.
The mode of operation, repeatability, heater controls, periodic update rate
-and crc validity can be changed through
+and CRC validity can be changed through
.Xr sysctl 8
nodes.
.Sh SYSCTL VARIABLES
The following
-.Xr sysctl 3
+.Xr sysctl 8
variables are provided:
-.Bl -tag -width indent
+.Bl -tag -width Li
.It Li hw.sht3xtemp0.modes
Lists the modes supported by the driver and chip.
.It Li hw.sht3xtemp0.mode
@@ -95,18 +95,20 @@ The delays are documented in the datashe
The driver will attempt to read back the values readattempts number of
times.
The default is 10 which should be more than enough for most purposes.
-.It hw.sht3xtemp0.clockstretch
+.It Li hw.sht3xtemp0.clockstretch
The chip supports a set of commands that lets it use I2C clock
-stretching to perform the temperature or humidity measurement. If
-this is set to 1 then use the clock stretching commands with the
-device. Note that the I2C controller must support clock stretching
-in order for this to work reliability. When this option is enabled,
-the readattempts sysctl noted above will not be used. This option only
-apply to single shot measurements.
+stretching to perform the temperature or humidity measurement.
+If this is set to 1 then use the clock stretching commands with the
+device.
+Note that the I2C controller must support clock stretching in order
+for this to work reliability.
+When this option is enabled, the readattempts sysctl noted above will
+not be used.
+This option only apply to single shot measurements.
.El
.Sh FILES
-.Bl -tag -width "/dev/sht3xtempu" -compact
-.It /dev/sht3xtemp Ns Ar u
+.Bl -tag -width Pa -compact
+.It Pa /dev/sht3xtemp Ns Ar u
SHT3X device unit
.Ar u
file.
