Bug 36377

Summary: kernel path needs to be changed in -current manual pages
Product: Documentation Reporter: Hiten Pandya <hiten>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Hiten Pandya 2002-03-27 18:20:00 UTC 
	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.
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-27 23:20:34 UTC 
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
Comment 2 hiten pandya 2002-03-27 23:48:21 UTC 
--- 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/
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2002-05-10 16:36:19 UTC 
State Changed
From-To: open->closed

This has been fixed already, and joe committed the rest 2 days ago.