From hitenp@hpdi.ath.cx  Wed Mar 27 10:16:07 2002
Return-Path: <hitenp@hpdi.ath.cx>
Received: from hpdi.ath.cx (pc2-nthf5-0-cust237.not.cable.ntl.com [80.4.35.237])
	by hub.freebsd.org (Postfix) with ESMTP id 9ECEF37B419
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 27 Mar 2002 10:16:06 -0800 (PST)
Received: from hpdi.ath.cx (localhost [127.0.0.1])
	by hpdi.ath.cx (8.12.2/8.12.2) with ESMTP id g2RICn5a005670
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 27 Mar 2002 18:12:49 GMT
	(envelope-from hitenp@hpdi.ath.cx)
Received: (from hitenp@localhost)
	by hpdi.ath.cx (8.12.2/8.12.2/Submit) id g2RICnQE005669;
	Wed, 27 Mar 2002 18:12:49 GMT
Message-Id: <200203271812.g2RICnQE005669@hpdi.ath.cx>
Date: Wed, 27 Mar 2002 18:12:49 GMT
From: Hiten Pandya <hiten@uk.FreeBSD.org>
Reply-To: Hiten Pandya <hiten@uk.FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: kernel path needs to be changed in -current manual pages
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         36377
>Category:       docs
>Synopsis:       kernel path needs to be changed in -current manual pages
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          update
>Submitter-Id:   current-users
>Arrival-Date:   Wed Mar 27 10:20:00 PST 2002
>Closed-Date:    Fri May 10 08:37:15 PDT 2002
>Last-Modified:  Fri May 10 08:37:15 PDT 2002
>Originator:     Hiten Pandya
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hpdi.ath.cx 5.0-CURRENT FreeBSD 5.0-CURRENT #2: Thu Mar 21 20:05:18 GMT 2002 hitenp@hpdi.ath.cx:/c1/obj/data/dev/src/sys/CURRENT5 i386

>Description:

	Some manual pages in -current need to be changed which refer to 
	the /kernel file patch.  FreeBSD-CURRENT man pages have to make
	use of /boot/kernel/kernel and not /kernel.  I am attaching a
	patch for a taster.  If this patch is agreed upon, then I can
	submit more patches for the same change, which has to be made to
	say.. a _lot_ of (not) utilities not limited to:
	
		o iostat(8)
		o pstat(8)
		o getextattr(8)
	
	
	I am attaching a patch which will change the path in the kgmon(8)
	manual page.  If more are needed for other man pages as described
	above, please submit a followup to this list, and I will make the
	patches personally and submit them as a followup to this PR.

	Thanks,
	Regards,

	-- Hiten Pandya
	-- <hiten@uk.FreeBSD.org>

	P.S. : I have submitted this PR under the update class as this is not
	a bug under -STABLE, which refers to /kernel AFAIK.
	
>How-To-Repeat:
	Look at the kgmon(8) manual page (in -CURRENT) as a sampler.
>Fix:

	Index: kgmon.8
	===================================================================
	RCS file: /home/ncvs/src/usr.sbin/kgmon/kgmon.8,v
	retrieving revision 1.10
	diff -u -r1.10 kgmon.8
	--- kgmon.8	2001/07/15 08:02:07	1.10
	+++ kgmon.8	2002/03/27 18:02:39
	@@ -87,7 +87,7 @@
	 .It Fl N
	 Extract the name list from the specified system instead of the
	 default
	-.Pa /kernel .
	+.Pa /boot/kernel/kernel .
	 .El
	 .Pp
	 If neither
	@@ -108,7 +108,7 @@
	 of the profile data is changed.
	 .Sh FILES
	 .Bl -tag -width /dev/kmemx -compact
	-.It Pa /kernel
	+.It Pa /boot/kernel/kernel
	 the default system
	 .It Pa /dev/kmem
	 the default memory
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: Hiten Pandya <hiten@uk.FreeBSD.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36377: kernel path needs to be changed in -current manual
 pages
Date: Thu, 28 Mar 2002 01:20:34 +0200 (EET)

 On 2002-03-27 18:12, Hiten Pandya wrote:
 
 > >Description:
 >
 > 	Some manual pages in -current need to be changed which refer to
 > 	the /kernel file patch.
 
 Good catch :)
 I just did the following:
 
     % cd /usr/src
     % find . -name '*.[0-9]' | xargs grep /kernel | grep -v /boot/kernel
 
 and the files that were caught by the greps are shown below (just in case
 you want to attack them one by one, and submit patches for those that need
 to be changed/updated). This is a lot more work that it initially seems
 though.  One needs to check if the manpage describes what the code does.
 There might be utilities left that use /kernel, instead of the currently
 used /boot/kernel/kernel, to find the kernel.  This means that before the
 manpage is changed, the appropriate source files need to be checked, to
 make sure that the manpage reflects what really happens in the programs
 themselves.  We don't want to blindly substitute /boot/kernel/kernel for
 all the instances of /kernel, and make the manpages inconsistent with the
 source, right?
 
 But, enough with the words.  Here is the file list:
 
     src/bin/ps/ps.1
     src/lib/libc/gen/getbootfile.3
     src/sbin/nextboot/nextboot.8
     src/sbin/reboot/boot_i386.8
     src/sbin/savecore/savecore.8
     src/share/man/man4/vinum.4
     src/share/man/man8/crash.8
     src/share/man/man9/DECLARE_MODULE.9
     src/share/man/man9/DEV_MODULE.9
     src/share/man/man9/DRIVER_MODULE.9
     src/share/man/man9/SYSCALL_MODULE.9
     src/share/man/man9/VFS_SET.9
     src/share/man/man9/domain.9
     src/share/man/man9/module.9
     src/share/man/man9/taskqueue.9
     src/share/man/man9/uio.9
     src/sys/boot/common/loader.8
     src/sys/boot/forth/loader.conf.5
     src/usr.bin/fstat/fstat.1
     src/usr.bin/ipcs/ipcs.1
     src/usr.bin/nfsstat/nfsstat.1
     src/usr.bin/symorder/symorder.1
     src/usr.bin/systat/systat.1
     src/usr.bin/vmstat/vmstat.8
     src/usr.bin/w/uptime.1
     src/usr.bin/w/w.1
     src/usr.sbin/getextattr/getextattr.8
     src/usr.sbin/iostat/iostat.8
     src/usr.sbin/kernbb/kernbb.8
     src/usr.sbin/kgmon/kgmon.8
     src/usr.sbin/pstat/pstat.8
     src/usr.sbin/rwhod/rwhod.8
     src/usr.sbin/setextattr/setextattr.8
     src/usr.sbin/trpt/trpt.8
 

From: Hiten Pandya <hitmaster2k@yahoo.com>
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36377: kernel path needs to be changed in -current manual pages
Date: Wed, 27 Mar 2002 15:48:21 -0800 (PST)

 --- Giorgos Keramidas <keramida@freebsd.org> wrote:
 > Good catch :)
 > I just did the following:
 > 
 >     % cd /usr/src
 >     % find . -name '*.[0-9]' | xargs grep /kernel | grep -v /boot/kernel
 > 
 > and the files that were caught by the greps are shown below (just in case
 > you want to attack them one by one, and submit patches for those that need
 > to be changed/updated). This is a lot more work that it initially seems
 > though.  One needs to check if the manpage describes what the code does.
 > There might be utilities left that use /kernel, instead of the currently
 > used /boot/kernel/kernel, to find the kernel.  This means that before the
 > manpage is changed, the appropriate source files need to be checked, to
 > make sure that the manpage reflects what really happens in the programs
 > themselves.  We don't want to blindly substitute /boot/kernel/kernel for
 > all the instances of /kernel, and make the manpages inconsistent with the
 > source, right?
 
 Yup, you are absolutely right, but I according to my limited knowledge, I
 think it doesn't matter if the file is /kernel or /boot/kernel/kernel, as
 nothing is actually hard-coded which points directly to /kernel.. although
 I may be wrong...  maybe someone superior than me has some input to make
 on this issue.. 8-)
 
 > [ .. snip .. snip .. ]
 src/usr.sbin/kgmon/kgmon.8  - This one is done.  All it needs is the patch
 attached in this PR to be committed as I have checked this in my system as,
 and probably so can you... you will need the "profile" option in your kernel
 and you can do the following on a -CURRENT system if you are unsure about
 my change:
 
    %su
    [..magic password..]
    #kgmon -B (or -b) -N /boot/kernel/kernel
 
 The above will work fine with a profile kernel, so in a nutshell, my attached
 patch will not hurt this utility.  For the rest in the list you gave me, I am
 sure it will not take more than two to three days to get it sorted, as I am
 having holidays... :)
 
 I am working on the list you have provided, and patches should be seen on
 this PR in a few days. :)
 
 Btw, thanks for the list.
 
 Thanks,
 
   -- Hiten Pandya
   -- <hiten@uk.FreeBSD.org>
 
 __________________________________________________
 Do You Yahoo!?
 Yahoo! Movies - coverage of the 74th Academy Awards
 http://movies.yahoo.com/
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Fri May 10 08:36:19 PDT 2002 
State-Changed-Why:  
This has been fixed already, and joe committed the rest 2 days ago. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=36377 
>Unformatted:
