Bug 13211

Summary: [LIST] Some man pages has references to nonexisting pages.
Product: Documentation Reporter: sobomax <sobomax>
Component: Books & ArticlesAssignee: chris <chris>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.dat none

Description sobomax 1999-08-18 00:40:00 UTC
Following is the list of man pages which contains references to nonexisting other manuals.
In collumn 1 is the man page on which bad reference found, in collumn 2 is the reffered page (nonexistant obviously) and in column 3 is my guess of what should be insted (when it was possible).
Probably some of these references is "work in progress", however for me it is hard to tell exactly.

Man Page		Bad Reference		Possible Replacement
--------------------------------------------------------------------
bus_generic_map_intr(9)	BUS_MAP_INTR(9)
security(7)		accton(1)			accton(8)
amd(8)			automount(8)
camcontrol(8)		cam(9)
sh(1)			case(1)
cam(3)			ccb(4)
error(1)		ccom(1)
mount_cd9660		cdcontrol(8)			cdcontrol(1)
sb(4)			cdplay(1)
fe(4)			crd(4)
amq(8)			ctl-amd(8)
cx(4)			cxconfig(8)
aliases(5)		dbm(3)
sio(4)			dca(4)
device_add_child(9)	device_add_child_ordered(9)
device_quiet(9)		device_detach(9)	
device(9)		device_get_parent(9)
intro(6)		dm(8)
restore(8)		dumpdir(8)
el(4)			eg(4)
edquota(8)		fstab(2)			fstab(5)
config(8)		gdb(8)				gdb(1)
vnode(9)		getnewvnode(9)
natd(8)			getservbyname(2)		getservbyname(3)
time(9)			gettime(9)
routed(8)		htable(8)
inet(4)			igmp(4)
install-info(1)		info(1)
keyadmin(8)		ipsec(4)
rc.conf(5)		ipxrouted(8)			IPXrouted(8)
mi_switch(9)		issignal(9)
reboot(2)		kadb(4)
splash(4)		keymap(5)
core(5)			kgdb(1)
ldd(1)			ld.so(1)
gethostbyname(3)	libc(3)
sysinstall(8)		libdialog(3)			dialog(3)
kld(4)			lkm(4)
chpass(5)		login.conf(5,)			login.conf(5)
sr(4)			lsdev(8)
mem(4)			memcontrol(8)
time(9)			microtime(9)
wst(4)			mt(4)
amd(8)			mtab(5)
ncr(4)			nca(4)
mknetid(8)		netid(5)
ppbus(4)		nlpt(4)				lpt(4)
dnsquery(1)		nsquery(1)
dnsquery(1)		nstest(1)
hlfsd(8)		passwd(4)			passwd(5)
gprof(1)		pc(1)
usb(4)			pci(4)
ppbus(4)		ppbconf(9)
en(4)			pvcsif(8)
en(4)			pvctxctl(8)
loader.conf(5)		rc.conf(8)			rc.conf(5)
xntpd(8)		rename(3)			rename(2)
fixmount(8)		rmtab(5)
rpcgen(1)		rpc_svc_calls(3)
ldd(1)			rtld(1)
security(7)		scp(1)
syscons(4)		screenmap(5)
cd(9)			scsiconf(9)
newfs(8)		scsiformat(8)
named(8)		signal(2)			signal(3)
slstat(8)		ststat(1)
ndc(8)			syslog(2)			syslog(3)
amd.conf(5)		syslog(8)			syslogd(8)
security(7)		syslogd(1)			syslogd(8)
rtprio(1)		tcpdump(8)			tcpdump(1)
login_cap(3)		termcap(5,)			termcap(5)
rc.conf(5)		tickadj(8)
zic(8)			time(2)				time(3)
vnode(9)		vbusy(9)
vnode(9)		vdrop(9)
vnode(9)		vfree(9)
vnode(9)		vhold(9)
vnode(9)		vfs_object_create(9)
VFS_UNMOUNT(9)		vflush(9)
VFS_FHTOVP(9)		vfs_export_lookup(9)
boot(9)			vfs_unmountall(9)
umass(4)		vpo(8)				vpo(4)
wfd(4)			wcd(4)
wfd(4)			wdc(4)				wd(4)
wst(4)			wst(1)
ti(4)			vlan(4)

How-To-Repeat: $ man ....
Comment 1 chris freebsd_committer freebsd_triage 1999-08-18 00:51:49 UTC
Responsible Changed
From-To: freebsd-doc->chris

I'm already working on this sort of thing. 

Comment 2 phantom 1999-08-18 07:29:29 UTC
hi max and -doc,

> >Number:         13211
> >Category:       docs
> >Synopsis:       [LIST] Some man pages has references to nonexisting pages.

Just a note -- I also reviewed Bad Cross References staff. And would like
to comment something.

> Man Page		Bad Reference		Possible Replacement
> --------------------------------------------------------------------

> amq(8)			ctl-amd(8)
> amd(8)			automount(8)
This is contrib/ staff. I already noticed FreeBSD MANINAINER. Seems
that he not imported these tools.

> camcontrol(8)		cam(9)
Report to author -- I against of removing any refence in 9 section if
I not sure that it's stale staff. Sometimes authors just don't have time
to write these pages (as I see from their letters)

> sh(1)			case(1)
Not only this staff. This manpage also references to set(1), alias(1), but
these pages are hard links to csh(1). Therefore these Xr's will be removed.
This patch is made and comming soon.

> cam(3)			ccb(4)
I have noticed author, ken@FreeBSD.org. He reported this morning that
problem is fixed.

> sb(4)			cdplay(1)
I reviewed commitlogs staff and seems that it was removed from source tree,
but I sure what this will be replaced with .Pr later. So, don't touch that
now.

> fe(4)			crd(4)
Seems that it's something descriptive about PCCARD. 

> cx(4)			cxconfig(8)
BTW, this tool present in source tree, but it's disabled since about 1996.
Anyone know why ?

> aliases(5)		dbm(3)
Also I saw nbdm(3) references. I think we need to import them GNU staff.

> sio(4)			dca(4)

> device_add_child(9)	device_add_child_ordered(9)
I have submited already patch about this problem.

> device(9)		device_get_parent(9)
I notified author also. Waiting for his answer.

> intro(6)		dm(8)
It's present.

> restore(8)		dumpdir(8)
dumpdir(8) is used as reference to obsolete tool which was replaced with
restore(8).

> el(4)			eg(4)
Was removed by phk at 1998/12/27

> vnode(9)
And also time.9 have many invalid Xr's.

After partial review I see that we missing lot of manpages. For example:

ld.so(1) 	I think it should be (8)
ld.so(5)
keymap(5)
screenmap(5)
isaignal(9)
libc(3)
libcurses(3)
libdisk(3)
dbm(3)
etc.

> install-info(1)		info(1)
Seems that need to be imported.

> sysinstall(8)		libdialog(3)			dialog(3)
This is not good to make replacement. I think better way is just
add new MLINKS entry, i.e. MLINKS=+ dialog(3) libdialog(3)

> sr(4)			lsdev(8)
Was removed.

> mem(4)			memcontrol(8)
Still has no manpage.

> dnsquery(1)		nsquery(1)
> dnsquery(1)		nstest(1)
Seems that some bind utils were not imported.

> security(7)		scp(1)
.Pr candidate

-- 

Sincerely Yours,
Alexey Zelkin          mailto:phantom@sunbay.com, ICQ: #6196584
Sunbay Software, Ltd.  http://www.sunbay.com
Comment 3 Alexey M. Zelkin 1999-08-18 15:31:14 UTC
hi max and -doc,

> >Number:         13211
> >Category:       docs
> >Synopsis:       [LIST] Some man pages has references to nonexisting pages.

Just a note -- I also reviewed Bad Cross References staff. And would like
to comment something.

> Man Page		Bad Reference		Possible Replacement
> --------------------------------------------------------------------

> amq(8)			ctl-amd(8)
> amd(8)			automount(8)
This is contrib/ staff. I already noticed FreeBSD MANINAINER. Seems
that he not imported these tools.

> camcontrol(8)		cam(9)
Report to author -- I against of removing any refence in 9 section if
I not sure that it's stale staff. Sometimes authors just don't have time
to write these pages (as I see from their letters)

> sh(1)			case(1)
Not only this staff. This manpage also references to set(1), alias(1), but
these pages are hard links to csh(1). Therefore these Xr's will be removed.
This patch is made and comming soon.

> cam(3)			ccb(4)
I have noticed author, ken@FreeBSD.org. He reported this morning that
problem is fixed.

> sb(4)			cdplay(1)
I reviewed commitlogs staff and seems that it was removed from source tree,
but I sure what this will be replaced with .Pr later. So, don't touch that
now.

> fe(4)			crd(4)
Seems that it's something descriptive about PCCARD. 

> cx(4)			cxconfig(8)
BTW, this tool present in source tree, but it's disabled since about 1996.
Anyone know why ?

> aliases(5)		dbm(3)
Also I saw nbdm(3) references. I think we need to import them GNU staff.

> sio(4)			dca(4)

> device_add_child(9)	device_add_child_ordered(9)
I have submited already patch about this problem.

> device(9)		device_get_parent(9)
I notified author also. Waiting for his answer.

> intro(6)		dm(8)
It's present.

> restore(8)		dumpdir(8)
dumpdir(8) is used as reference to obsolete tool which was replaced with
restore(8).

> el(4)			eg(4)
Was removed by phk at 1998/12/27

> vnode(9)
And also time.9 have many invalid Xr's.

After partial review I see that we missing lot of manpages. For example:

ld.so(1) 	I think it should be (8)
ld.so(5)
keymap(5)
screenmap(5)
isaignal(9)
libc(3)
libcurses(3)
libdisk(3)
dbm(3)
etc.

> install-info(1)		info(1)
Seems that need to be imported.

> sysinstall(8)		libdialog(3)			dialog(3)
This is not good to make replacement. I think better way is just
add new MLINKS entry, i.e. MLINKS=+ dialog(3) libdialog(3)

> sr(4)			lsdev(8)
Was removed.

> mem(4)			memcontrol(8)
Still has no manpage.

> dnsquery(1)		nsquery(1)
> dnsquery(1)		nstest(1)
Seems that some bind utils were not imported.

> security(7)		scp(1)
.Pr candidate

-- 
Sincerely Yours,   | phantom@crimea.edu      (primary)
Alexey Zelkin      | phantom@scorpion.crimea.ua (home)
                   | ICQ: #6196584,  FIDO: 2:460/12.26
Comment 4 sobomax 1999-09-22 04:55:25 UTC
Probably after Phantom's general manpages cleanup this PR has nothing to
do. I'm suggesting to close it.

-Max
Comment 5 Maxim Sobolev freebsd_committer freebsd_triage 2000-05-18 10:59:00 UTC
State Changed
From-To: open->closed

Outdated, and superseeded by doc people work.