Bug 135316

Summary: [patch][doc] Add 'make installworld' section to jails-build.html
Product: Documentation Reporter: Glen Barber <glen.j.barber>
Component: Books & ArticlesAssignee: Manolis Kiagias <manolis>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
jails-build.txt none

Description Glen Barber 2009-06-06 17:00:14 UTC
Section 15.4 of the jail(8) documentation specifies to 'make world' when creating a jail.  Assuming subsequent jail creation will use the same userland / kernel, and are in sync with the host userland / kernel, the need to 'make world' may be unclear to new users after the userland is already built.

Fix: The attached patch adds a section for subsequent jails, replacing 'make world' with 'make installworld'.

Patch attached with submission follows:
Comment 1 Manolis Kiagias freebsd_committer freebsd_triage 2009-06-06 21:31:46 UTC
Glen Barber wrote:
>> Number:         135316
>> Category:       docs
>> Synopsis:       [patch][doc] Add 'make installworld' section to jails-build.html
>> Confidential:   no
>> Severity:       non-critical
>> Priority:       low
>> Responsible:    freebsd-doc
>> State:          open
>> Quarter:        
>> Keywords:       
>> Date-Required:
>> Class:          change-request
>> Submitter-Id:   current-users
>> Arrival-Date:   Sat Jun 06 16:00:14 UTC 2009
>> Closed-Date:
>> Last-Modified:
>> Originator:     Glen Barber
>> Release:        7.2-STABLE
>> Organization:
>> Environment:
>>     
> FreeBSD phoenix 7.2-STABLE FreeBSD 7.2-STABLE #0 r192129M: Thu May 14 22:53:56 UTC 2009     root@phoenix:/usr/obj/usr/src/sys/GENERIC  i386
>   
>> Description:
>>     
> Section 15.4 of the jail(8) documentation specifies to 'make world' when creating a jail.  Assuming subsequent jail creation will use the same userland / kernel, and are in sync with the host userland / kernel, the need to 'make world' may be unclear to new users after the userland is already built. 
>   
>> How-To-Repeat:
>>     
>
>   
>> Fix:
>>     
> The attached patch adds a section for subsequent jails, replacing 'make world' with 'make installworld'.
>
> >
> --- /usr/share/doc/en_US.ISO8859-1/books/handbook/jails-build.html.original	2009-06-06 11:34:02.000000000 -0400
> +++ /usr/share/doc/en_US.ISO8859-1/books/handbook/jails-build.html	2009-06-06 11:41:42.000000000 -0400
> @@ -66,6 +66,30 @@
>  vspace="0" border="0" alt="(4)" /></a>
>  </pre>
>  
>   

Hi Glen,

The above HTML file is produced from this original SGML one:

http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/handbook/jails/chapter.sgml?rev=1.17;content-type=text%2Fplain

Detailed information on syntax and build procedures may be found on the
FreeBSD Doc Primer:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

It would be best for us if you could supply a patch against the SGML
file. If this is too much trouble, please send you submission in plain
text,  and will take care of the formatting.

Thanks!
Comment 2 Glen Barber 2009-06-06 23:10:10 UTC
Hi, Manolis.

Thanks for the point in the right direction.

I'll submit a corrected patch, hopefully within the next day.

Thanks!

--Glen Barber
Comment 3 Glen Barber 2009-06-07 14:33:04 UTC
Attached is a .sgml patch.

Thanks!

-- Glen Barber
Comment 4 gjb35 2009-06-07 14:53:08 UTC
Good ol' Gmail destroyed my patch.  Hopefully this one will come out a little better. 

-- Glen Barber


--- /usr/doc/en_US.ISO8859-1/books/handbook/jails/chapter.sgml.orig	2009-06-07 09:09:11.000000000 -0400
+++ /usr/doc/en_US.ISO8859-1/books/handbook/jails/chapter.sgml	2009-06-07 09:22:32.000000000 -0400
@@ -242,12 +242,25 @@
       <screen>&prompt.root; <userinput>setenv D <replaceable>/here/is/the/jail</replaceable></userinput>
 &prompt.root; <userinput>mkdir -p $D</userinput> <co id="jailpath">
 &prompt.root; <userinput>cd /usr/src</userinput>
-&prompt.root; <userinput>make world DESTDIR=$D</userinput> <co id="jailworld">
+&prompt.root; <userinput>make buildworld</userinput>
+&prompt.root; <userinput>make installworld DESTDIR=$D</userinput> <co id="jailworld">
 &prompt.root; <userinput>cd etc/</userinput> <footnote><para>This step
 is not required on &os; 6.0 and later.</para></footnote>
 &prompt.root; <userinput>make distribution DESTDIR=$D</userinput> <co id="jaildistrib">
 &prompt.root; <userinput>mount -t devfs devfs $D/dev</userinput> <co id="jaildevfs"></screen>
 
+     <para>If you have already rebuilt your userland and kernel using <command>make world</command> or 
+<command>make buildworld</command>, you can skip the buildworld process and install your existing userland into a new jail.</para>
+
+      <screen>&prompt.root; <userinput>setenv D <replaceable>/here/is/the/jail</replaceable></userinput>
+&prompt.root; <userinput>mkdir -p $D</userinput> 
+&prompt.root; <userinput>cd /usr/src</userinput>
+&prompt.root; <userinput>make installworld DESTDIR=$D</userinput> 
+&prompt.root; <userinput>cd etc/</userinput> <footnote><para>This step
+is not required on &os; 6.0 and later.</para></footnote>
+&prompt.root; <userinput>make distribution DESTDIR=$D</userinput> 
+&prompt.root; <userinput>mount -t devfs devfs $D/dev</userinput> </screen>
+
     <calloutlist>
       <callout arearefs="jailpath">
 	<para>Selecting a location for a jail is the best starting point.
Comment 5 Manolis Kiagias freebsd_committer freebsd_triage 2009-06-07 14:57:26 UTC
Glen Barber wrote:
> The following reply was made to PR docs/135316; it has been noted by GNATS.
>
> From: Glen Barber <glen.j.barber@gmail.com>
> To: bug-followup@FreeBSD.org
> Cc:  
> Subject: Re: docs/135316: [patch][doc] Add 'make installworld' section to 
> 	jails-build.html
> Date: Sun, 7 Jun 2009 09:33:04 -0400
>
>  --001636c5b31f4de686046bc22af0
>  Content-Type: text/plain; charset=ISO-8859-1
>  Content-Transfer-Encoding: 7bit
>  
>  Attached is a .sgml patch.
>  
>  Thanks!
>
>   

Unfortunately it seems the mailer messed this up.
Please try resending using different settings / mail account - if all
else fails send directly to me in a gzipped file.
Thanks!
Comment 6 Manolis Kiagias freebsd_committer freebsd_triage 2009-06-07 17:01:45 UTC
Responsible Changed
From-To: freebsd-doc->manolis

I will handle this one
Comment 7 dfilter service freebsd_committer freebsd_triage 2009-06-08 17:25:32 UTC
manolis     2009-06-08 16:25:24 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/jails chapter.sgml 
  Log:
  Split the 'make world' step in two steps (buildworld/installworld).
  Note that 'buildworld' need only be done once.
  
  PR:             docs/135316
  Submitted by:   Glen Barber <glen.j.barber at gmail.com>
  
  Revision  Changes    Path
  1.18      +11 -6     doc/en_US.ISO8859-1/books/handbook/jails/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 8 Manolis Kiagias freebsd_committer freebsd_triage 2009-06-08 17:31:54 UTC
State Changed
From-To: open->closed

Committed, thanks!