Skip site navigation (1)Skip section navigation (2) 
Date:      Thu, 26 Feb 1998 00:23:56 GMT
From:      Nik Clayton <nik@nothing-going-on.demon.co.uk>
To:        FreeBSD-gnats-submit@FreeBSD.ORG
Subject:   docs/5853: [PATCH] Update handbook to include pointer to 'make world' tutorial
Message-ID:  <199802260023.AAA22301@nothing-going-on.demon.co.uk>
next in thread | raw e-mail | index | archive | help 

>Number:         5853
>Category:       docs
>Synopsis:       [PATCH] Update handbook to include pointer to 'make world' tutorial
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    freebsd-bugs
>State:          open
>Quarter:
>Keywords:
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Feb 25 16:30:01 PST 1998
>Last-Modified:
>Originator:     Nik Clayton
>Organization:
N/A
>Release:        FreeBSD 2.2.5-STABLE i386
>Environment:

N/A

>Description:

There's currently nothing in the handbook that explains how to properly
go about 'make world'.

My tutorial on the subject (which is linked to from the FreeBSD site)
is marked up in DocBook. Unfortunately, the handbook is still in LinuxDoc.
After talking with Steve Price (who responded to one of my earlier PRs)
I suggested, and he agreed, that I should put together a small section
for the handbook that essentially says "For more info about 'make world',
go *here*" which gets a pointer to the information into the handbook.

I can then lend a hand to the DocBook porting effort that's underway.

This PR contains a patch to some existing files, and an entirely new
file.

The new file (makeworld.sgml) contains the pointer to the tutorial.

The patches update 

    Makefile                 - References makeworld.sgml
    authors.sgml             - Updates my e-mail address
    current.sgml             - Includes a link to the 'make world' section
    handbook.sgml            - Includes the 'makeworld' entity
    hw.sgml                  - Includes a link to the 'make world' section
    sections.sgml            - Defines the 'makeworld' entity
    stable.sgml              - Includes a link to the 'make world' section

'makeworld.sgml' is included in the Handbook at the same level as the 
"Staying Current with FreeBSD" and "Staying Stable with FreeBSD" 
sections.

>How-To-Repeat:

N/A

>Fix:
	
First, cut-n-paste this into a file, and call it makeworld.sgml in the
handbook directory.

-----------------------------------------------------------------------------
<!-- $Id$ -->
<!-- The FreeBSD Documentation Project -->

<sect><heading>Using <bf>make world</bf> to rebuild your system<label id="makeworld"></heading>

<p><em>Contributed by &a.nik;.</em>

<!--

Last updated: $Date$

This document is a placeholder for the "How to run 'make world'" section.
Currently, it just links to my tutorial. It is intended that, once the
Handbook has been converted, the tutorial referenced here will be slightly
rewritten and used here.    
-->

    <p>Once you have synchronised your local source tree against a particular
      version of FreeBSD (<tt>stable</tt>, <tt>current</tt> and so on) you
      must then use the source tree to rebuild the system.</p>

    <p>Currently, the best source of information on how to do that is a
      tutorial available from <htmlurl
	url="http://www.nothing-going-on.demon.co.uk/FreeBSD/make-world/make-world.html" name="http://www.nothing-going-on.demon.co.uk/FreeBSD/make-world/make-world.html">.</p>;

    <p>A successor to this tutorial will be integrated into the handbook.</p>
-----------------------------------------------------------------------------
Then apply these patches

Index: Makefile
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/Makefile,v
retrieving revision 1.29
diff -u -r1.29 Makefile
--- Makefile	1998/02/19 06:45:26	1.29
+++ Makefile	1998/02/26 00:04:35
@@ -8,7 +8,7 @@
 SRCS+= firewalls.sgml german.sgml glossary.sgml goals.sgml
 SRCS+= handbook.sgml history.sgml hw.sgml install.sgml isdn.sgml 
 SRCS+= kerberos.sgml kernelconfig.sgml kerneldebug.sgml kernelopts.sgml
-SRCS+= lists.sgml mail.sgml memoryuse.sgml
+SRCS+= lists.sgml makeworld.sgml mail.sgml memoryuse.sgml
 SRCS+= mirrors.sgml nfs.sgml nutshell.sgml pgpkeys.sgml policies.sgml
 SRCS+= porting.sgml ports.sgml ppp.sgml printing.sgml 
 SRCS+= quotas.sgml relnotes.sgml routing.sgml russian.sgml
Index: authors.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/authors.sgml,v
retrieving revision 1.90
diff -u -r1.90 authors.sgml
--- authors.sgml	1998/02/22 23:54:55	1.90
+++ authors.sgml	1998/02/25 23:52:29
@@ -363,8 +363,8 @@
   name='&lt;nate@FreeBSD.ORG&gt;'></tt>">
 
 <!ENTITY a.nik "Nik Clayton
-  <tt><htmlurl url='mailto:nik@iii.co.uk'
-  name='&lt;nik@iii.co.uk&gt;'></tt>">
+  <tt><htmlurl url='mailto:nik@nothing-going-on.demon.co.uk'
+  name='&lt;nik@nothing-going-on.demon.co.uk&gt;'></tt>">
 
 <!ENTITY a.nsj "Nate Johnson
   <tt><htmlurl url='mailto:nsj@FreeBSD.ORG'
Index: current.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/current.sgml,v
retrieving revision 1.23
diff -u -r1.23 current.sgml
--- current.sgml	1997/09/02 08:22:31	1.23
+++ current.sgml	1998/02/26 00:05:30
@@ -143,9 +143,9 @@
     guaranteed to get you into trouble.
 
     <item>  Before compiling current, read the Makefile in /usr/src
-	carefully.  You should at least run a `make world' the first time
-        through as part of the upgrading process.
-        Reading the &a.current will keep you up-to-date on other
+	carefully.  You should at least run a `<ref id="makeworld"
+	name="make world">' the first time through as part of the upgrading
+	process. Reading the &a.current will keep you up-to-date on other
         bootstrapping procedures that sometimes become necessary as we move
         towards	the next release.
 
Index: handbook.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/handbook.sgml,v
retrieving revision 1.81
diff -u -r1.81 handbook.sgml
--- handbook.sgml	1997/11/18 16:06:08	1.81
+++ handbook.sgml	1998/02/26 00:05:00
@@ -153,6 +153,7 @@
       &current;
       &stable;
       &synching; 
+      &makeworld;
     </chapt>
 
     &submitters;
Index: hw.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/hw.sgml,v
retrieving revision 1.79
diff -u -r1.79 hw.sgml
--- hw.sgml	1998/02/19 06:45:27	1.79
+++ hw.sgml	1998/02/26 00:06:46
@@ -86,11 +86,11 @@
     drops have dropped P6 systems into a very affordable price bracket,
     at least in the United States, and for serious server applications you
     may wish to look no further than the Pentium Pro.  My personal
-    `make world' times dropped from 3 hours and 40 minutes with a P5/166
-    to 1 hour and 22 minutes when I upgraded to a P6/200 machine - not
-    a fair comparison, to be sure, but just to note that in terms of
-    increased productivity, the P6/200 has definitely been worth the upgrade
-    for me.
+    `<ref id="makeworld" name="makeworld">' times dropped from 3 hours and
+    40 minutes with a P5/166 to 1 hour and 22 minutes when I upgraded to a
+    P6/200 machine - not a fair comparison, to be sure, but just to note
+    that in terms of increased productivity, the P6/200 has definitely been
+    worth the upgrade for me.
 
     NOTE: The Intel motherboards are designed to a different form-factor
     and hence require <em>an entirely different PC case</em>, the so-called
Index: sections.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/sections.sgml,v
retrieving revision 1.27
diff -u -r1.27 sections.sgml
--- sections.sgml	1998/02/19 06:45:30	1.27
+++ sections.sgml	1998/02/26 00:04:49
@@ -35,6 +35,7 @@
 <!ENTITY kernelopts SYSTEM "kernelopts.sgml">
 <!ENTITY linuxemu SYSTEM "linuxemu.sgml">
 <!ENTITY mail SYSTEM "mail.sgml">
+<!ENTITY makeworld SYSTEM "makeworld.sgml">
 <!ENTITY memoryuse SYSTEM "memoryuse.sgml">
 <!ENTITY mirrors SYSTEM "mirrors.sgml">
 <!ENTITY nfs SYSTEM "nfs.sgml">
Index: stable.sgml
===================================================================
RCS file: /usr/local/cvs-reps/FreeBSD/doc/handbook/stable.sgml,v
retrieving revision 1.16
diff -u -r1.16 stable.sgml
--- stable.sgml	1997/10/21 16:14:26	1.16
+++ stable.sgml	1998/02/26 00:07:48
@@ -100,9 +100,9 @@
     Otherwise, use CTM.
 
     <item>  Before compiling stable, read the Makefile in /usr/src
-	carefully.  You should at least run a `make world' the first time
-        through as part of the upgrading process.
-        Reading the &a.stable will keep you up-to-date on other bootstrapping
-        procedures that sometimes become necessary as we move towards the next
-        release.
+	carefully.  You should at least run a `<ref id="makeworld"
+	name="make world">' the first time through as part of the upgrading
+	process. Reading the &a.stable will keep you up-to-date on other
+	bootstrapping procedures that sometimes become necessary as we move
+	towards the next release.
 </enum>
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-bugs" in the body of the message

Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199802260023.AAA22301>