xnu-344.2.tar.gz

[apple/xnu.git] / README

diff --git a/README b/README
index 690dd7893b3b8810e91cf5947b14d17d2ccb0046..0d4d3285aaf29d869325eae54cce7882af6c5307 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,6 @@
 How to build XNU:
 
 How to build XNU:
 

-1) Setup your environment:
-
-  Create and go to your sandbox directory </sandbox/my_xnu>
-
-  $ cd </sandbox/my_xnu>
-
-  Extract the xnu project from cvs:
-
-  $ cvs co -r <xnu-tag> xnu
-
-  where <xnu-tag> must be replaced by the matching xnu tag for
-  the xnu project level.
-
-  Go to the top directory in your XNU project.
-
-  $ cd </sandbox/my_xnu>/xnu
-
-  If you are using a sh-style shell, run the following command:
-    $ . SETUP/setup.sh
-
-  If you are using a csh-style shell, run the following command:
-    % source SETUP/setup.csh
-
-  This will define the following environmental variables:
-    SRCROOT, OBJROOT, DSTROOT, SYMROOT
-
-2) Export the Component Header Files
-
-  From the top directory, run:
-
-  $ make exporthdrs
-
-  This exports the component header files in the $OBJROOT/EXPORT_HDRS 
-  directory.
-
-3) Build all the Components
-
-  From the top directory. run:
-
-    $ make all
+1) Type: "make"

 
   This builds all the components for all architectures defined in 
   ARCH_CONFIGS and for all kernel configurations defined in KERNEL_CONFIGS.
 
   This builds all the components for all architectures defined in 
   ARCH_CONFIGS and for all kernel configurations defined in KERNEL_CONFIGS.


@@ -52,7 +13,18 @@ How to build XNU:
     $(OBJROOT)/RELEASE_PPC/osfmk/RELEASE/osfmk.o: pre-linked object for osfmk component
     $(OBJROOT)/RELEASE_PPC/mach_kernel: bootable image
 
     $(OBJROOT)/RELEASE_PPC/osfmk/RELEASE/osfmk.o: pre-linked object for osfmk component
     $(OBJROOT)/RELEASE_PPC/mach_kernel: bootable image
 

-4) Building a Component
+2) Building a Component
+
+  Go to the top directory in your XNU project.
+
+  If you are using a sh-style shell, run the following command:
+     $ . SETUP/setup.sh
+
+  If you are using a csh-style shell, run the following command:
+     % source SETUP/setup.csh
+
+  This will define the following environmental variables:
+    SRCROOT, OBJROOT, DSTROOT, SYMROOT

 
   From a component top directory:
 
 
   From a component top directory:
 


@@ -63,9 +35,6 @@ How to build XNU:
   By default, ARCH_CONFIGS contains one architecture, the build machine 
   architecture, and KERNEL_CONFIGS is set to build for RELEASE .
 
   By default, ARCH_CONFIGS contains one architecture, the build machine 
   architecture, and KERNEL_CONFIGS is set to build for RELEASE .
 

-  WARNING: If a component header file has been modified, you will have to do 
-           the above procedures 3 and 4.
-

   Example:
     $(OBJROOT)/RELEASE_PPC/osfmk/RELEASE/osfmk.o: pre-linked object for osfmk component
 
   Example:
     $(OBJROOT)/RELEASE_PPC/osfmk/RELEASE/osfmk.o: pre-linked object for osfmk component
 


@@ -76,7 +45,10 @@ How to build XNU:
   This includes your component in the bootable image, mach_kernel,  and 
   in the kernel binary with symbols, mach_kernel.sys.
 
   This includes your component in the bootable image, mach_kernel,  and 
   in the kernel binary with symbols, mach_kernel.sys.
 

-5) Building DEBUG
+  WARNING: If a component header file has been modified, you will have to do 
+           the above procedure 1.
+
+3) Building DEBUG

 
   Define KERNEL_CONFIGS to DEBUG in your environment or when running a 
   make command.  Then, apply procedures 4, 5
 
   Define KERNEL_CONFIGS to DEBUG in your environment or when running a 
   make command.  Then, apply procedures 4, 5


@@ -92,7 +64,7 @@ How to build XNU:
     $(OBJROOT)/DEBUG_PPC/osfmk/DEBUG/osfmk.o: pre-linked object for osfmk component
     $(OBJROOT)/DEBUG_PPC/mach_kernel: bootable image
 
     $(OBJROOT)/DEBUG_PPC/osfmk/DEBUG/osfmk.o: pre-linked object for osfmk component
     $(OBJROOT)/DEBUG_PPC/mach_kernel: bootable image
 

-6) Building fat
+4) Building fat

 
   Define ARCH_CONFIGS in your environment or when running a make command.
   Apply procedures 3, 4, 5
 
   Define ARCH_CONFIGS in your environment or when running a make command.
   Apply procedures 3, 4, 5


@@ -104,13 +76,13 @@ How to build XNU:
   $ export ARCH_CONFIGS="PPC I386"
   $ make exporthdrs all
 
   $ export ARCH_CONFIGS="PPC I386"
   $ make exporthdrs all
 

-7) Build check before integration
+5) Build check before integration

 
   From the top directory, run:
 
     $ ~rc/bin/buildit . -arch ppc -arch i386 -noinstallsrc -nosum
 
 
   From the top directory, run:
 
     $ ~rc/bin/buildit . -arch ppc -arch i386 -noinstallsrc -nosum
 

-8) Creating tags and cscope
+6) Creating tags and cscope

 
   Set up your build environment as per instructions in 2a
 
 
   Set up your build environment as per instructions in 2a