NetBSD Problem Report #21345

Received: (qmail 22023 invoked by uid 605); 28 Apr 2003 00:20:24 -0000
Message-Id: <200304280020.h3S0KJ6c006691@arne.augustsson.net>
Date: Mon, 28 Apr 2003 02:20:19 +0200 (MEST)
From: Lennart Augustsson <lennart@augustsson.net>
Sender: gnats-bugs-owner@netbsd.org
Reply-To: lennart@augustsson.net
To: gnats-bugs@gnats.netbsd.org
Subject: Many i386 device man pages are missing
X-Send-Pr-Version: 3.95

>Number:         21345
>Category:       kern
>Synopsis:       Many i386 device man pages are missing
>Confidential:   no
>Severity:       serious
>Priority:       low
>Responsible:    kern-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Mon Apr 28 00:21:01 +0000 2003
>Closed-Date:    
>Last-Modified:  Sat Jul 10 05:25:01 +0000 2021
>Originator:     Lennart Augustsson
>Release:        NetBSD 1.6R
>Organization:
>Environment:
System: NetBSD arne 1.6R NetBSD 1.6R (ARNE) #6: Sat Apr 26 01:34:23 MEST 2003 lennart@arne:/usr/src/sys/arch/i386/compile/ARNE i386
Architecture: i386
Machine: i386
>Description:
	There are many major devices for i386 that have no man page.
	I'm a firm believer in having a man page for every device type.
>How-To-Repeat:
	cd sys/arch/i386/conf
	awk '/device-major/ { print "man 4 " $2 }' < majors.i386 | sh > /dev/null
man: no entry for cons in the manual.
man: no entry for ctty in the manual.
man: no entry for swap in the manual.
man: no entry for pts in the manual.
man: no entry for ptc in the manual.
man: no entry for log in the manual.
man: no entry for scd in the manual.
man: no entry for pc in the manual.
man: no entry for filedesc in the manual.
man: no entry for opms in the manual.
man: no entry for svr4_net in the manual.
man: no entry for satlink in the manual.
man: no entry for vcoda in the manual.
man: no entry for sysmon in the manual.
man: no entry for vmegeneric in the manual.
man: no entry for altq in the manual.
man: no entry for wsfont in the manual.
man: no entry for netsmb in the manual.
man: no entry for kttcp in the manual.
man: no entry for verifiedexec in the manual.
man: no entry for fwiso in the manual.
man: no entry for nsmb in the manual.
man: no entry for vmmon in the manual.
man: no entry for vmnet in the manual.
man: no entry for ksyms in the manual.

>Fix:
	Each author of the device code writes the corresponding man page.
	In some cases only a link is needed.
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: kern-bug-people->jruoho
Responsible-Changed-By: jruoho@NetBSD.org
Responsible-Changed-When: Wed, 22 Jun 2011 11:17:00 +0000
Responsible-Changed-Why:
> Each author of the device code writes the corresponding man page.
> In some cases only a link is needed.

What a fine suggestion this was.

Some of the noted pages have been written. I will try to write few more.    



From: "Jukka Ruohonen" <jruoho@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/21345 CVS commit: src
Date: Wed, 22 Jun 2011 19:34:54 +0000

 Module Name:	src
 Committed By:	jruoho
 Date:		Wed Jun 22 19:34:53 UTC 2011

 Modified Files:
 	src/distrib/sets/lists/man: mi
 	src/share/man/man4: Makefile
 Added Files:
 	src/share/man/man4: sysmon.4

 Log Message:
 Add a small summary page for sysmon. From the list in PR # kern/21345.


 To generate a diff of this commit:
 cvs rdiff -u -r1.1319 -r1.1320 src/distrib/sets/lists/man/mi
 cvs rdiff -u -r1.558 -r1.559 src/share/man/man4/Makefile
 cvs rdiff -u -r0 -r1.1 src/share/man/man4/sysmon.4

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

From: "Jukka Ruohonen" <jruoho@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/21345 CVS commit: src
Date: Wed, 22 Jun 2011 20:29:39 +0000

 Module Name:	src
 Committed By:	jruoho
 Date:		Wed Jun 22 20:29:39 UTC 2011

 Modified Files:
 	src/distrib/sets/lists/man: mi
 	src/share/man/man4: Makefile
 Added Files:
 	src/share/man/man4: altq.4

 Log Message:
 Add a small summary page for altq. From the list in PR # kern/21345.


 To generate a diff of this commit:
 cvs rdiff -u -r1.1320 -r1.1321 src/distrib/sets/lists/man/mi
 cvs rdiff -u -r1.559 -r1.560 src/share/man/man4/Makefile
 cvs rdiff -u -r0 -r1.1 src/share/man/man4/altq.4

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

Responsible-Changed-From-To: jruoho->kern-bug-people
Responsible-Changed-By: dholland@NetBSD.org
Responsible-Changed-When: Sun, 20 Jan 2019 07:48:41 +0000
Responsible-Changed-Why:
Reset responsible field for retired developer.


From: David Holland <dholland-bugs@netbsd.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Sun, 20 Jan 2019 07:59:55 +0000

  > Synopsis: Many i386 device man pages are missing
  >    :
  > cd sys/arch/i386/conf
  > awk '/device-major/ { print "man 4 " $2 }' < majors.i386 | sh > /dev/null

 Today's list:
 man: no entry for apm in the manual.
 man: no entry for cmos in the manual.
 man: no entry for cons in the manual.
 man: no entry for ct in the manual.
 man: no entry for ctty in the manual.
 man: no entry for ed in the manual.
 man: no entry for filedesc in the manual.
 man: no entry for log in the manual.
 man: no entry for mt in the manual.
 man: no entry for olms in the manual.
 man: no entry for omms in the manual.
 man: no entry for opms in the manual.
 man: no entry for pc in the manual.
 man: no entry for ppi in the manual.
 man: no entry for ptc in the manual.
 man: no entry for pts in the manual.
 man: no entry for rd in the manual.
 man: no entry for satlink in the manual.
 man: no entry for scd in the manual.
 man: no entry for svr4_net in the manual.
 man: no entry for swap in the manual.
 man: no entry for vcoda in the manual.
 man: no entry for xencons in the manual.
 man: no entry for xenevt in the manual.


 -- 
 David A. Holland
 dholland@netbsd.org

From: Jason Thorpe <thorpej@me.com>
To: "gnats-bugs@netbsd.org" <gnats-bugs@NetBSD.org>
Cc: kern-bug-people@netbsd.org,
 gnats-admin@netbsd.org,
 netbsd-bugs@netbsd.org,
 lennart@augustsson.net
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Sun, 20 Jan 2019 07:59:12 -0800

 > On Jan 20, 2019, at 12:00 AM, David Holland <dholland-bugs@netbsd.org> =
 wrote:
 >=20
 > The following reply was made to PR kern/21345; it has been noted by =
 GNATS.
 >=20
 > From: David Holland <dholland-bugs@netbsd.org>
 > To: gnats-bugs@NetBSD.org
 > Cc:=20
 > Subject: Re: kern/21345 (Many i386 device man pages are missing)
 > Date: Sun, 20 Jan 2019 07:59:55 +0000
 >=20
 >> Synopsis: Many i386 device man pages are missing
 >>   :
 >> cd sys/arch/i386/conf
 >> awk '/device-major/ { print "man 4 " $2 }' < majors.i386 | sh > =
 /dev/null

 This points to a bunch of drivers that should be removed.

 Certainly, "satlink" falls into that category:

 ----------------------------
 revision 1.1
 date: 1997-07-13 19:09:46 +0000;  author: hpeyerl;  state: Exp;
 branches:  1.1.2;
 Satellite receiver driver for ISA cards from PlanetConnect by Jason and
 Herb for Canada Connect Corp.
 ----------------------------

 I doubt that anyone is using this device anymore.

 All of the "o" flavors of the legacy mouse drivers should probably get =
 garbage-collected, as well ("olms", "omms", "opms") -- these are =
 hold-overs from pre-wscons days.

 >=20
 > Today's list:
 > man: no entry for apm in the manual.
 > man: no entry for cmos in the manual.
 > man: no entry for cons in the manual.
 > man: no entry for ct in the manual.
 > man: no entry for ctty in the manual.
 > man: no entry for ed in the manual.
 > man: no entry for filedesc in the manual.
 > man: no entry for log in the manual.
 > man: no entry for mt in the manual.
 > man: no entry for olms in the manual.
 > man: no entry for omms in the manual.
 > man: no entry for opms in the manual.
 > man: no entry for pc in the manual.
 > man: no entry for ppi in the manual.
 > man: no entry for ptc in the manual.
 > man: no entry for pts in the manual.
 > man: no entry for rd in the manual.
 > man: no entry for satlink in the manual.
 > man: no entry for scd in the manual.
 > man: no entry for svr4_net in the manual.
 > man: no entry for swap in the manual.
 > man: no entry for vcoda in the manual.
 > man: no entry for xencons in the manual.
 > man: no entry for xenevt in the manual.
 >=20
 >=20
 > --=20
 > David A. Holland
 > dholland@netbsd.org
 >=20

 -- thorpej

From: David Young <dyoung@pobox.com>
To: gnats-bugs@NetBSD.org
Cc: kern-bug-people@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org, lennart@augustsson.net
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Tue, 22 Jan 2019 11:24:06 -0600

 On Sun, Jan 20, 2019 at 08:00:01AM +0000, David Holland wrote:
 > The following reply was made to PR kern/21345; it has been noted by GNATS.
 > 
 > From: David Holland <dholland-bugs@netbsd.org>
 > To: gnats-bugs@NetBSD.org
 > Cc: 
 > Subject: Re: kern/21345 (Many i386 device man pages are missing)
 > Date: Sun, 20 Jan 2019 07:59:55 +0000
 > 
 >   > Synopsis: Many i386 device man pages are missing
 >   >    :
 >   > cd sys/arch/i386/conf
 >   > awk '/device-major/ { print "man 4 " $2 }' < majors.i386 | sh > /dev/null
 >  
 >  Today's list:
 >  man: no entry for apm in the manual.
 >  man: no entry for cmos in the manual.

 NetBSD 5 or 6 had apm(4) and cmos(4).  Where did they go?

 Dave

 -- 
 David Young
 dyoung@pobox.com    Urbana, IL    (217) 721-9981

From: David Holland <dholland-bugs@netbsd.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Tue, 22 Jan 2019 17:32:56 +0000

 On Tue, Jan 22, 2019 at 05:25:00PM +0000, David Young wrote:
  >  >  Today's list:
  >  >  man: no entry for apm in the manual.
  >  >  man: no entry for cmos in the manual.
  >  
  >  NetBSD 5 or 6 had apm(4) and cmos(4).  Where did they go?

 apm(4) probably got removed. Dunno about cmos...

 -- 
 David A. Holland
 dholland@netbsd.org

From: Martin Husemann <martin@duskware.de>
To: gnats-bugs@NetBSD.org
Cc: kern-bug-people@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org, lennart@augustsson.net
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Tue, 22 Jan 2019 19:31:44 +0100

 On Tue, Jan 22, 2019 at 05:35:00PM +0000, David Holland wrote:
 >  
 >  apm(4) probably got removed. Dunno about cmos...

 Still there: env MACHINE=i386 man cmos
 (as well as apm(4)).

 Martin

From: Masanobu SAITOH <msaitoh@execsw.org>
To: gnats-bugs@NetBSD.org, kern-bug-people@netbsd.org,
 gnats-admin@netbsd.org, netbsd-bugs@netbsd.org, lennart@augustsson.net
Cc: msaitoh@execsw.org
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Wed, 23 Jan 2019 12:52:49 +0900

 On 2019/01/23 3:35, Martin Husemann wrote:
 > The following reply was made to PR kern/21345; it has been noted by GNATS.
 > 
 > From: Martin Husemann <martin@duskware.de>
 > To: gnats-bugs@NetBSD.org
 > Cc: kern-bug-people@netbsd.org, gnats-admin@netbsd.org,
 > 	netbsd-bugs@netbsd.org, lennart@augustsson.net
 > Subject: Re: kern/21345 (Many i386 device man pages are missing)
 > Date: Tue, 22 Jan 2019 19:31:44 +0100
 > 
 >   On Tue, Jan 22, 2019 at 05:35:00PM +0000, David Holland wrote:
 >   >
 >   >  apm(4) probably got removed. Dunno about cmos...
 >   
 >   Still there: env MACHINE=i386 man cmos
 >   (as well as apm(4)).
 >   
 >   Martin
 >   
 > 

 See also:

 	http://gnats.netbsd.org/cgi-bin/query-pr-single.pl?number=51748

 -- 
 -----------------------------------------------
                  SAITOH Masanobu (msaitoh@execsw.org
                                   msaitoh@netbsd.org)

From: David Holland <dholland-bugs@netbsd.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Wed, 23 Jan 2019 16:16:45 +0000

 On Tue, Jan 22, 2019 at 06:35:01PM +0000, Martin Husemann wrote:
  >  On Tue, Jan 22, 2019 at 05:35:00PM +0000, David Holland wrote:
  >  >  
  >  >  apm(4) probably got removed. Dunno about cmos...
  >  
  >  Still there: env MACHINE=i386 man cmos
  >  (as well as apm(4)).

 Erm, I made the list wrong...

 % awk '/device-major/ { print $2 ".4" }' < majors.i386 | sort | awk '{ printf "[ -f /usr/share/man/man4/%s ] || [ -f /usr/share/man/man4/i386/%s ] || [ -f /usr/share/man/man4/x86/%s ] || echo %s\n", $1, $1, $1, $1; }' | sh

 ct.4
 ctty.4
 filedesc.4
 log.4
 mt.4
 olms.4
 omms.4
 opms.4
 pc.4
 ppi.4
 ptc.4
 pts.4
 rd.4
 satlink.4
 scd.4
 svr4_net.4
 swap.4
 vcoda.4
 xencons.4
 xenevt.4

 but of those at least ctty, filedesc, ptc, pts, and swap are bogus
 hits, and log should appear in section 4 as klog (though it doesn't...)

 -- 
 David A. Holland
 dholland@netbsd.org

From: matthew green <mrg@eterna.com.au>
To: Martin Husemann <martin@duskware.de>
Cc: kern-bug-people@netbsd.org, gnats-admin@netbsd.org,
    netbsd-bugs@netbsd.org, lennart@augustsson.net,
    gnats-bugs@NetBSD.org
Subject: re: kern/21345 (Many i386 device man pages are missing)
Date: Thu, 24 Jan 2019 10:12:33 +1100

 Martin Husemann writes:
 > On Tue, Jan 22, 2019 at 05:35:00PM +0000, David Holland wrote:
 > >  
 > >  apm(4) probably got removed. Dunno about cmos...
 > 
 > Still there: env MACHINE=i386 man cmos
 > (as well as apm(4)).

 FWIW, you can get this with "man i386/cmos".

 most of the shared pages got moved into x86 subdir i thought,
 which both i386 and amd64 search.  might also need a update
 to man.conf if you have an old system.  eg, man.conf has:

 # machine classes per machine
 _i386           x86
 _amd64          x86
 _sparc64        sparc

 now days.


 .mrg.

From: "Maxime Villard" <maxv@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/21345 CVS commit: src
Date: Sun, 27 Jan 2019 08:53:31 +0000

 Module Name:	src
 Committed By:	maxv
 Date:		Sun Jan 27 08:53:31 UTC 2019

 Modified Files:
 	src/distrib/sets/lists/comp: mi
 	src/etc: MAKEDEV.tmpl
 	src/etc/etc.algor: MAKEDEV.conf
 	src/etc/etc.alpha: MAKEDEV.conf
 	src/etc/etc.amd64: MAKEDEV.conf
 	src/etc/etc.bebox: MAKEDEV.conf
 	src/etc/etc.evbmips: MAKEDEV.conf
 	src/etc/etc.i386: MAKEDEV.conf
 	src/etc/etc.ia64: MAKEDEV.conf
 	src/etc/etc.ofppc: MAKEDEV.conf
 	src/etc/etc.sbmips: MAKEDEV.conf
 	src/share/man/man9: ioctl.9
 	src/sys/arch/algor/conf: majors.algor
 	src/sys/arch/alpha/conf: GENERIC majors.alpha
 	src/sys/arch/amd64/conf: ALL majors.amd64
 	src/sys/arch/bebox/conf: majors.bebox
 	src/sys/arch/evbmips/conf: majors.evbmips
 	src/sys/arch/i386/conf: ALL GENERIC GENERIC_TINY INSTALL_FLOPPY
 	    INSTALL_TINY majors.i386
 	src/sys/arch/ia64/conf: majors.ia64
 	src/sys/arch/ibmnws/conf: majors.ibmnws
 	src/sys/arch/mvmeppc/conf: majors.mvmeppc
 	src/sys/arch/powerpc/conf: majors.powerpc
 	src/sys/arch/prep/conf: majors.prep
 	src/sys/arch/riscv/conf: majors.riscv
 	src/sys/dev: DEVNAMES
 	src/sys/dev/isa: Makefile files.isa
 	src/sys/rump/librump/rumpkern: devsw.c
 Removed Files:
 	src/sys/dev/isa: satlink.c satlinkio.h satlinkreg.h

 Log Message:
 Remove the satlink driver. It was disabled everywhere, had no man page and
 no use either. Spotted by thorpej in PR/21345, ok christos.


 To generate a diff of this commit:
 cvs rdiff -u -r1.2252 -r1.2253 src/distrib/sets/lists/comp/mi
 cvs rdiff -u -r1.196 -r1.197 src/etc/MAKEDEV.tmpl
 cvs rdiff -u -r1.6 -r1.7 src/etc/etc.algor/MAKEDEV.conf
 cvs rdiff -u -r1.12 -r1.13 src/etc/etc.alpha/MAKEDEV.conf
 cvs rdiff -u -r1.26 -r1.27 src/etc/etc.amd64/MAKEDEV.conf
 cvs rdiff -u -r1.9 -r1.10 src/etc/etc.bebox/MAKEDEV.conf
 cvs rdiff -u -r1.9 -r1.10 src/etc/etc.evbmips/MAKEDEV.conf
 cvs rdiff -u -r1.28 -r1.29 src/etc/etc.i386/MAKEDEV.conf
 cvs rdiff -u -r1.2 -r1.3 src/etc/etc.ia64/MAKEDEV.conf
 cvs rdiff -u -r1.10 -r1.11 src/etc/etc.ofppc/MAKEDEV.conf
 cvs rdiff -u -r1.5 -r1.6 src/etc/etc.sbmips/MAKEDEV.conf
 cvs rdiff -u -r1.33 -r1.34 src/share/man/man9/ioctl.9
 cvs rdiff -u -r1.24 -r1.25 src/sys/arch/algor/conf/majors.algor
 cvs rdiff -u -r1.387 -r1.388 src/sys/arch/alpha/conf/GENERIC
 cvs rdiff -u -r1.31 -r1.32 src/sys/arch/alpha/conf/majors.alpha
 cvs rdiff -u -r1.113 -r1.114 src/sys/arch/amd64/conf/ALL
 cvs rdiff -u -r1.29 -r1.30 src/sys/arch/amd64/conf/majors.amd64
 cvs rdiff -u -r1.28 -r1.29 src/sys/arch/bebox/conf/majors.bebox
 cvs rdiff -u -r1.31 -r1.32 src/sys/arch/evbmips/conf/majors.evbmips
 cvs rdiff -u -r1.461 -r1.462 src/sys/arch/i386/conf/ALL
 cvs rdiff -u -r1.1199 -r1.1200 src/sys/arch/i386/conf/GENERIC
 cvs rdiff -u -r1.161 -r1.162 src/sys/arch/i386/conf/GENERIC_TINY
 cvs rdiff -u -r1.47 -r1.48 src/sys/arch/i386/conf/INSTALL_FLOPPY
 cvs rdiff -u -r1.158 -r1.159 src/sys/arch/i386/conf/INSTALL_TINY
 cvs rdiff -u -r1.48 -r1.49 src/sys/arch/i386/conf/majors.i386
 cvs rdiff -u -r1.14 -r1.15 src/sys/arch/ia64/conf/majors.ia64
 cvs rdiff -u -r1.16 -r1.17 src/sys/arch/ibmnws/conf/majors.ibmnws
 cvs rdiff -u -r1.22 -r1.23 src/sys/arch/mvmeppc/conf/majors.mvmeppc
 cvs rdiff -u -r1.11 -r1.12 src/sys/arch/powerpc/conf/majors.powerpc
 cvs rdiff -u -r1.24 -r1.25 src/sys/arch/prep/conf/majors.prep
 cvs rdiff -u -r1.3 -r1.4 src/sys/arch/riscv/conf/majors.riscv
 cvs rdiff -u -r1.319 -r1.320 src/sys/dev/DEVNAMES
 cvs rdiff -u -r1.10 -r1.11 src/sys/dev/isa/Makefile
 cvs rdiff -u -r1.171 -r1.172 src/sys/dev/isa/files.isa
 cvs rdiff -u -r1.46 -r0 src/sys/dev/isa/satlink.c
 cvs rdiff -u -r1.4 -r0 src/sys/dev/isa/satlinkio.h
 cvs rdiff -u -r1.3 -r0 src/sys/dev/isa/satlinkreg.h
 cvs rdiff -u -r1.9 -r1.10 src/sys/rump/librump/rumpkern/devsw.c

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

From: David Holland <dholland-bugs@netbsd.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: kern/21345 (Many i386 device man pages are missing)
Date: Sat, 10 Jul 2021 05:22:48 +0000

 On Wed, Jan 23, 2019 at 04:20:00PM +0000, David Holland wrote:
  >  % awk '/device-major/ { print $2 ".4" }' < majors.i386 | sort | awk '{ printf "[ -f /usr/share/man/man4/%s ] || [ -f /usr/share/man/man4/i386/%s ] || [ -f /usr/share/man/man4/x86/%s ] || echo %s\n", $1, $1, $1, $1; }' | sh

 Stick ^ in the initial awk pattern or it looks for commented out ones.

 Also as previously noted these are false positives:

    ctty filedesc log ptc pts swap

 (though klog(4) for "log" should exist and doesn't)

 That leaves these:

 ct.4
 esh.4
 mt.4
 pc.4
 ppi.4
 rd.4
 vcoda.4
 xencons.4
 xenevt.4

 -- 
 David A. Holland
 dholland@netbsd.org

>Unformatted:

NetBSD Home
NetBSD PR Database Search

(Contact us) $NetBSD: query-full-pr,v 1.46 2020/01/03 16:35:01 leot Exp $
$NetBSD: gnats_config.sh,v 1.9 2014/08/02 14:16:04 spz Exp $
Copyright © 1994-2020 The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.