NetBSD Problem Report #37958

From Ephaeton@gmx.net  Mon Feb  4 22:30:42 2008
Return-Path: <Ephaeton@gmx.net>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by narn.NetBSD.org (Postfix) with ESMTP id 79AE563BB03
	for <gnats-bugs@gnats.NetBSD.org>; Mon,  4 Feb 2008 22:30:42 +0000 (UTC)
Message-Id: <20080204223038.9BC61D754@circe.entropie.net>
Date: Mon,  4 Feb 2008 23:30:38 +0100 (CET)
From: Ephaeton@gmx.net
Reply-To: Ephaeton@gmx.net
To: gnats-bugs@gnats.NetBSD.org
Subject: iic(4) documentation missing.
X-Send-Pr-Version: 3.95

>Number:         37958
>Category:       misc
>Synopsis:       iic(4) manpage(s) missing.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pgoyette
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Mon Feb 04 22:35:00 +0000 2008
>Closed-Date:    Thu Feb 25 17:08:54 +0000 2010
>Last-Modified:  Thu Feb 25 17:10:03 +0000 2010
>Originator:     Martin S. Weber
>Release:        NetBSD 4.99.52
>Organization:

>Environment:


System: NetBSD circe.entropie.net 4.99.52 NetBSD 4.99.52 (GENERIC) #0: Mon Feb 4 13:19:18 CET 2008 root@circe.entropie.net:/src/obj/sys/arch/i386/compile/GENERIC i386
Architecture: i386
Machine: i386
>Description:
	the iic(4) manpage is referenced from a handful other manpages, but
	there is no man 4 iic.

	The following reference iic(4):
	ddc(4), ichsmb(4), piixpm(4), spdmem(4), iic(9).

	The following probably should reference iic(4) (but do not):
	adt7467(4), cuda(4), rs5c372rtc(4), seeprom(4), sgsmix(4),
	iic(9).

	lmtemp(4) is referring to some i2c (which is a iic??).

>How-To-Repeat:
	man -k iic; man piixpm; man ...; read & wonder.

>Fix:


>Release-Note:

>Audit-Trail:

Responsible-Changed-From-To: misc-bug-people->pgoyette
Responsible-Changed-By: pgoyette@NetBSD.org
Responsible-Changed-When: Mon, 22 Feb 2010 03:43:31 +0000
Responsible-Changed-Why:
I grabbed it.


State-Changed-From-To: open->closed
State-Changed-By: pgoyette@NetBSD.org
State-Changed-When: Mon, 22 Feb 2010 03:43:31 +0000
State-Changed-Why:
We imported a iic(4) man page in June 2009.


From: "Martin S. Weber" <Ephaeton@gmx.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/37958 (iic(4) manpage(s) missing.)
Date: Mon, 22 Feb 2010 00:50:19 -0500

 On Mon, Feb 22, 2010 at 03:43:32AM +0000, pgoyette@NetBSD.org wrote:
 > State-Changed-From-To: open->closed
 > State-Changed-By: pgoyette@NetBSD.org
 > State-Changed-When: Mon, 22 Feb 2010 03:43:31 +0000
 > State-Changed-Why:
 > We imported a iic(4) man page in June 2009.

 Ah, nice. Could this be pulled up to NetBSD-5, or does
 it carry -current (-6) specifics?

 Thanks for the followup.

 Regards,
 -Martin

From: "Martin S. Weber" <Ephaeton@gmx.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/37958 (iic(4) manpage(s) missing.)
Date: Mon, 22 Feb 2010 00:59:16 -0500

 On Mon, Feb 22, 2010 at 03:43:32AM +0000, pgoyette@NetBSD.org wrote:
 > Synopsis: iic(4) manpage(s) missing.
 > State-Changed-From-To: open->closed

 ... 

 also please check the manpages I enumerated: 

 cuda(4) was changed to refer to iic(9) but probably should refer
 to iic(4) now that we have it.

 rs5c372rtc(4) still does not refer to iic(4).

 seeprom(4) still does not refer to iic(4).

 sgsmix(4) refers to iic(9) but should refer to iic(4).

 TIA!

 -Martin

State-Changed-From-To: closed->analyzed
State-Changed-By: wiz@NetBSD.org
State-Changed-When: Mon, 22 Feb 2010 08:42:23 +0000
State-Changed-Why:
More work to do here.


From: "Martin S. Weber" <Ephaeton@gmx.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/37958 (iic(4) manpage(s) missing.)
Date: Mon, 22 Feb 2010 19:21:02 -0500

 Index: share/man/man4/cuda.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/cuda.4,v
 retrieving revision 1.4
 diff -w -u -i -t -r1.4 cuda.4
 --- share/man/man4/cuda.4	9 Mar 2009 19:24:28 -0000	1.4
 +++ share/man/man4/cuda.4	23 Feb 2010 00:20:22 -0000
 @@ -48,4 +48,4 @@
  .Xr obio 4 ,
  .Xr pmu 4 ,
  .Xr sgsmix 4 ,
 -.Xr iic 9
 +.Xr iic 4 .
 Index: share/man/man4/rs5c372rtc.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/rs5c372rtc.4,v
 retrieving revision 1.2
 diff -w -u -i -t -r1.2 rs5c372rtc.4
 --- share/man/man4/rs5c372rtc.4	15 Sep 2005 15:14:37 -0000	1.2
 +++ share/man/man4/rs5c372rtc.4	23 Feb 2010 00:20:22 -0000
 @@ -45,7 +45,8 @@
  interface defined in
  .Xr todr 9 .
  .Sh SEE ALSO
 -.Xr todr 9
 +.Xr todr 9 ,
 +.Xr iic 4 .
  .Sh HISTORY
  The
  .Nm
 Index: share/man/man4/seeprom.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/seeprom.4,v
 retrieving revision 1.2
 diff -w -u -i -t -r1.2 seeprom.4
 --- share/man/man4/seeprom.4	27 May 2009 19:24:00 -0000	1.2
 +++ share/man/man4/seeprom.4	23 Feb 2010 00:20:22 -0000
 @@ -39,6 +39,8 @@
  available from a variety of vendors.
  .Pp
  Access to the contents of the memory is through a character device.
 +.Sh SEE ALSO
 +.Xr iic 4 .
  .Sh HISTORY
  The
  .Nm
 Index: share/man/man4/sgsmix.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/sgsmix.4,v
 retrieving revision 1.3
 diff -w -u -i -t -r1.3 sgsmix.4
 --- share/man/man4/sgsmix.4	9 Mar 2009 19:24:28 -0000	1.3
 +++ share/man/man4/sgsmix.4	23 Feb 2010 00:20:22 -0000
 @@ -47,4 +47,4 @@
  .Sh SEE ALSO
  .Xr awacs 4 ,
  .Xr cuda 4 ,
 -.Xr iic 9
 +.Xr iic 4 .

From: "Martin S. Weber" <Ephaeton@gmx.net>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/37958 (iic(4) manpage(s) missing.)
Date: Thu, 25 Feb 2010 11:44:54 -0500

 --/04w6evG8XlLl3ft
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline

 After wiz@ made me aware of some issues with my patch, here's
 another one.  This time I kept the sorted sections; did not add a
 period at the end of referenced man pages; found another one that
 is referenced from iic(4) but not vice versa (amdpm); found another
 one that should refer to iic(4) (dbcool).  Also Thomas asked why
 the link to iic(9) should be *replaced* by iic(4) instead the latter
 being added. My answer was two-fold - 1) prior art (compare pcmcia(4)
 and its devices - the latter do not refer to pcmcia(9) but to (4))
 and 2) imho it makes more sense - section 4 is for kernel
 options/configs, section 9 is for kernel internals. The audience
 is different - 4 is the general user who is building her own kernel,
 while 9 is the hacker who is building her own device drivers or
 learning from NetBSD to improve apple internals ;)

 -Martin


 --/04w6evG8XlLl3ft
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename=p

 Index: amdpm.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/amdpm.4,v
 retrieving revision 1.6
 diff -w -u -i -t -r1.6 amdpm.4
 --- amdpm.4	30 Apr 2008 13:10:53 -0000	1.6
 +++ amdpm.4	25 Feb 2010 16:40:02 -0000
 @@ -41,6 +41,7 @@
  provides support for the AMD768 Power Management Controller
  and for the AMD8111 System Management Controller.
  .Sh SEE ALSO
 +.Xr iic 4 ,
  .Xr pci 4 ,
  .Xr rnd 4
  .Sh HISTORY
 Index: cuda.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/cuda.4,v
 retrieving revision 1.4
 diff -w -u -i -t -r1.4 cuda.4
 --- cuda.4	9 Mar 2009 19:24:28 -0000	1.4
 +++ cuda.4	25 Feb 2010 16:40:02 -0000
 @@ -48,4 +48,4 @@
  .Xr obio 4 ,
  .Xr pmu 4 ,
  .Xr sgsmix 4 ,
 -.Xr iic 9
 +.Xr iic 4
 Index: dbcool.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/dbcool.4,v
 retrieving revision 1.5
 diff -w -u -i -t -r1.5 dbcool.4
 --- dbcool.4	25 Feb 2010 02:19:28 -0000	1.5
 +++ dbcool.4	25 Feb 2010 16:40:02 -0000
 @@ -255,6 +255,7 @@
  .Ed
  .Sh SEE ALSO
  .Xr envsys 4 ,
 +.Xr iic 4 ,
  .Xr envstat 8 ,
  .Xr powerd 8 ,
  .Xr sysctl 8
 Index: rs5c372rtc.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/rs5c372rtc.4,v
 retrieving revision 1.2
 diff -w -u -i -t -r1.2 rs5c372rtc.4
 --- rs5c372rtc.4	15 Sep 2005 15:14:37 -0000	1.2
 +++ rs5c372rtc.4	25 Feb 2010 16:40:02 -0000
 @@ -45,6 +45,7 @@
  interface defined in
  .Xr todr 9 .
  .Sh SEE ALSO
 +.Xr iic 4 ,
  .Xr todr 9
  .Sh HISTORY
  The
 Index: seeprom.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/seeprom.4,v
 retrieving revision 1.2
 diff -w -u -i -t -r1.2 seeprom.4
 --- seeprom.4	27 May 2009 19:24:00 -0000	1.2
 +++ seeprom.4	25 Feb 2010 16:40:02 -0000
 @@ -39,6 +39,8 @@
  available from a variety of vendors.
  .Pp
  Access to the contents of the memory is through a character device.
 +.Sh SEE ALSO
 +.Xr iic 4
  .Sh HISTORY
  The
  .Nm
 Index: sgsmix.4
 ===================================================================
 RCS file: /cvsroot/src/share/man/man4/sgsmix.4,v
 retrieving revision 1.3
 diff -w -u -i -t -r1.3 sgsmix.4
 --- sgsmix.4	9 Mar 2009 19:24:28 -0000	1.3
 +++ sgsmix.4	25 Feb 2010 16:40:02 -0000
 @@ -47,4 +47,4 @@
  .Sh SEE ALSO
  .Xr awacs 4 ,
  .Xr cuda 4 ,
 -.Xr iic 9
 +.Xr iic 4

 --/04w6evG8XlLl3ft--

State-Changed-From-To: analyzed->closed
State-Changed-By: wiz@NetBSD.org
State-Changed-When: Thu, 25 Feb 2010 17:08:54 +0000
State-Changed-Why:
I committed the patch (after ordering SEE ALSO in cuda(4) ;) ).
Thanks!


From: Thomas Klausner <wiz@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/37958 CVS commit: src/share/man/man4
Date: Thu, 25 Feb 2010 17:08:01 +0000

 Module Name:	src
 Committed By:	wiz
 Date:		Thu Feb 25 17:08:01 UTC 2010

 Modified Files:
 	src/share/man/man4: amdpm.4 cuda.4 dbcool.4 rs5c372rtc.4 seeprom.4
 	    sgsmix.4

 Log Message:
 Apply patch from Martin S. Weber in PR 37958 that adds/fixes references
 to iic(4).


 To generate a diff of this commit:
 cvs rdiff -u -r1.6 -r1.7 src/share/man/man4/amdpm.4
 cvs rdiff -u -r1.4 -r1.5 src/share/man/man4/cuda.4
 cvs rdiff -u -r1.5 -r1.6 src/share/man/man4/dbcool.4
 cvs rdiff -u -r1.2 -r1.3 src/share/man/man4/rs5c372rtc.4 \
     src/share/man/man4/seeprom.4
 cvs rdiff -u -r1.3 -r1.4 src/share/man/man4/sgsmix.4

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

>Unformatted:

Home	PR Database Search