docs/137171: replacement of k8temp(4) by amdtemp(4) isn't reflected in documentation

[Valentin Davydov]

>Number:         137171
>Category:       docs
>Synopsis:       replacement of k8temp(4) by amdtemp(4) isn't reflected in documentation
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jul 27 11:50:01 UTC 2009
>Closed-Date:
>Last-Modified:
>Originator:     Valentin Davydov
>Release:        7.2-STABLE
>Organization:
State Optical Institute
>Environment:
FreeBSD kor.davydov.spb.su 7.2-STABLE FreeBSD 7.2-STABLE #6: Sun Jul 26 22:32:26 MSD 2009     root at kor.davydov.spb.su:/usr/obj/usr/src/sys/KOR  i386
>Description:
According to src/UPDATING:

20090521:
        The k8temp(4) driver has been renamed to amdtemp(4) since               
        support for K10 and K11 CPU families was added.

However, this change was not reflected in the manual page. This leads to misunderstanding and frustration of users which are not reading UPDATING regularly.
>How-To-Repeat:
On a fresh RELENG_7 (newer than 20090521) say "man amdtemp" or as root "kldload
k8temp". You'll get an error in both cases.
>Fix:
Try to apply the attached patch (it is untested!!!) and rebuild/reinstall in src/share/man/man4.

Patch attached with submission follows:

--- src/share/man/man4/Makefile.orig    2009-06-18 10:09:47.000000000 +0400
+++ src/share/man/man4/Makefile 2009-07-27 15:04:59.000000000 +0400
@@ -568,7 +568,7 @@
 _if_nxge.4=    if_nxge.4
 _if_wpi.4=     if_wpi.4
 _ipmi.4=       ipmi.4
-_k8temp.4=     k8temp.4
+_k8temp.4=     amdtemp.4
 _nfe.4=                nfe.4
 _nfsmb.4=      nfsmb.4
 _nve.4=                nve.4

--- src/share/man/man4/k8temp.4 2008-07-06 20:24:50.000000000 +0400
+++ src/share/man/man4/amdtemp.4        2009-07-27 13:45:03.000000000 +0400
@@ -23,27 +23,27 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/k8temp.4,v 1.1.2.1 2008/07/06 16:24:50 rpaulo Exp $
+.\" $FreeBSD: src/share/man/man4/amdtemp.4,v 1.1.2.1 2008/07/06 16:24:50 rpaulo Exp $
 .\"
 .Dd April 8, 2008
 .Dt K8TEMP 4
 .Os
 .Sh NAME
-.Nm k8temp
+.Nm amdtemp
 .Nd device driver for AMD K8 on-die digital thermal sensor
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following line in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device k8temp"
+.Cd "device amdtemp"
 .Ed
 .Pp
 Alternatively, to load the driver as a
 module at boot time, place the following line in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
-k8temp_load="YES"
+amdtemp_load="YES"
 .Ed
 .Sh DESCRIPTION
 The
@@ -55,7 +55,7 @@
 .Nm
 driver reports each cores' temperature through a sysctl node in the
 corresponding CPU devices's sysctl tree, named
-.Va dev.k8temp.%d.sensor{0,1}.core{0,1} .
+.Va dev.amdtemp.%d.sensor{0,1}.core{0,1} .
 .Va dev.cpu.%d.temperature
 is also created and it displays the maximum temperature of the two sensors
 located in each CPU core.



>Release-Note:
>Audit-Trail:
>Unformatted: