Bug 19818

Summary: /usr/share/man/man8/sysinstall.8 missing
Product: Documentation Reporter: Brian Candler <B.Candler>
Component: Books & ArticlesAssignee: ben <ben>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
diff none

Description Brian Candler 2000-07-10 10:30:01 UTC
sysinstall.8 man page is not in distribution; need to dig install
sources to find it under /usr/src/release/sysinstall/

Fix: 

Include sysinstall.8 along with the other manpages
How-To-Repeat: Install FreeBSD. Type "man sysinstall".
Comment 1 nik freebsd_committer freebsd_triage 2000-07-10 20:28:50 UTC
Jordan,

On Mon, Jul 10, 2000 at 02:20:06AM -0700, B.Candler@pobox.com wrote:
> >Number:         19818
> >Synopsis:       /usr/share/man/man8/sysinstall.8 missing
> >Originator:     Brian Candler
>
> sysinstall.8 man page is not in distribution; need to dig install
> sources to find it under /usr/src/release/sysinstall/

This is right.  Is there any reason we don't do this?  Otherwise, the
attached patch should do it.

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery
Comment 2 jkh 2000-07-11 08:19:22 UTC
> > sysinstall.8 man page is not in distribution; need to dig install
> > sources to find it under /usr/src/release/sysinstall/
> 
> This is right.  Is there any reason we don't do this?  Otherwise, the
> attached patch should do it.

Well, we don't do it because sysinstall isn't in the default build
path, is never touched by "make world" or "make distribute", and hence
never makes it into the man pages distribution with all the other
manual pages, even with Nik's patch to the Makefile.

I've thought of various types of evil hacks to work around this over
the years, but they always seemed more evil than simply omitting the
man page. :-)

- Jordan
Comment 3 dannyboy 2000-09-14 03:06:45 UTC
Can this be closed?

-- 
Daniel Harris
Comment 4 Brian Candler 2000-09-14 13:46:33 UTC
On Wed, Sep 13, 2000 at 10:06:45PM -0400, Daniel Harris wrote:
> Can this be closed?

Has anything changed, e.g. has the man page now found its way into -current
or -stable?

I generally don't install the O/S source (only kernel source), so it's a bit
of a pain not having the man page available.

Regards,

Brian.
Comment 5 csxbcs 2000-11-24 12:11:47 UTC
What about a patch like this to install sysinstall.8 by default?

--- Makefile    2000/05/04 17:36:28     1.16
+++ Makefile    2000/11/24 12:05:18
@@ -1,7 +1,10 @@
 #      @(#)Makefile    8.1 (Berkeley) 6/5/93
 # $FreeBSD: src/share/man/man8/Makefile,v 1.16 2000/05/04 17:36:28 archie Exp $
 
-MAN8=  adding_user.8 crash.8 diskless.8 intro.8 picobsd.8 rc.8 sticky.8
+.PATH: ${.CURDIR}/../../../release/sysinstall
+
+MAN8=  adding_user.8 crash.8 diskless.8 intro.8 picobsd.8 rc.8 sticky.8 \
+       sysinstall.8
 
 MLINKS=        rc.8 rc.serial.8 rc.8 rc.pccard.8 rc.8 rc.network.8 \
        rc.8 rc.firewall.8 rc.8 rc.atm.8 rc.8 rc.local.8 rc.8 rc.shutdown.8

Seems to work, and doesn't seem _too_ evil.  Any objections?

-- 
Ben Smithurst / csxbcs@comp.leeds.ac.uk / ben@FreeBSD.org
Comment 6 nik freebsd_committer freebsd_triage 2000-11-24 22:41:00 UTC
On Fri, Nov 24, 2000 at 12:11:47PM +0000, Ben Smithurst wrote:
> What about a patch like this to install sysinstall.8 by default?

<snip>

Looks OK to me.  Good idea.  Do you want to run it by Jordan.

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery
Comment 7 ben freebsd_committer freebsd_triage 2001-01-01 23:17:18 UTC
Responsible Changed
From-To: freebsd-doc->ben

I've committed a fix for this in -current, will probably MFC shortly.
Comment 8 ben freebsd_committer freebsd_triage 2001-01-08 22:34:59 UTC
State Changed
From-To: open->closed

Committed to both -current and 4-stable now.  Thanks!
Comment 9 cjc 2001-01-11 02:13:55 UTC
I just ran into this change while trying to buildworld. Previously,
nothing in the src-release module was required for a buildworld. This
one file, sysinstall.8 makes it a requirement. The release/ tree is
not that big, aboutt 1830KB, but nor is that completely negligable.

Is the fact that src-release is required really needed or desireable?
We can do a simple check to see if the release/ directory exists,

@@ -1,10 +1,13 @@
 #      @(#)Makefile    8.1 (Berkeley) 6/5/93
 # $FreeBSD: src/share/man/man8/Makefile,v 1.13.2.3 2001/01/05 22:06:29 ben Exp $
 
-.PATH: ${.CURDIR}/../../../release/sysinstall
 
-MAN8=  adding_user.8 crash.8 diskless.8 intro.8 picobsd.8 rc.8 sticky.8 \
-       sysinstall.8
+MAN8=  adding_user.8 crash.8 diskless.8 intro.8 picobsd.8 rc.8 sticky.8
+
+.if exists(${.CURDIR}/../../../release)
+.PATH: ${.CURDIR}/../../../release/sysinstall
+MAN8+=         sysinstall.8
+.endif
 
 MLINKS=        rc.8 rc.serial.8 rc.8 rc.pccard.8 rc.8 rc.network.8 \
        rc.8 rc.firewall.8 rc.8 rc.atm.8 rc.8 rc.local.8 rc.8 rc.shutdown.8

To get around this. That may not be pretty, but it works. Thanks.
-- 
Crist J. Clark                           cjclark@alum.mit.edu