OSDN Git Service

Update docs in preparation for release
[uclinux-h8/uClibc.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 4a84d21..5f8e141 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,29 +1,35 @@
 SOFTWARE REQUIREMENTS
 
-   Compiling and running uClibc requires Linux kernel header files.
-   uClibc will be compiled to match the interfaces available in the
-   provided version of the Linux kernel headers.  Linux kernel version
-   2.0, version 2.2, and version 2.4 are known to work.  Other kernel
-   versions may work but havn't been tested.  Its also helpful to have
-   a working version of GNU binutils, and GNU gcc -- using excessively
-   old versions of these packages can cause very strange errors that
-   are difficult to find and fix.
+   Compiling uClibc requires Linux kernel header files.  uClibc will
+   be compiled to match the interfaces available in the provided
+   version of the Linux kernel headers.  Linux kernel version 2.0,
+   version 2.2, version 2.4 and version 2.6 are known to work.  Other
+   kernel versions may work but havn't been tested.  Its also helpful
+   to have a working version of GNU binutils, and GNU gcc -- using
+   excessively old versions of these packages can cause very strange
+   errors that are difficult to find and fix.
 
 
 CONFIGURING uClibc:
 
- - Check the Rules.mak file and adjust CROSS to specify your cross-
-    compiler if you are cross compiling.
-
  - Use must have a valid configuration file to compile uClibc.  Do not
     skip this step.  New configuration options are added in each
-    release, and odd problems will turn up if your configuration file
-    is not set up as expected.  If you want to carry your existing
-    configuration to a new version with minimal work, use "make
-    oldconfig", which will only ask you for the answers to new
-    questions.
+    release, and odd configuration options are sometimes removed.
+    To configure uClibc, you can run:
+
+           make menuconfig
+    or
+           make config
+
+    If you have an existing .config file, you can update this file
+    using the
+
+           make oldconfig
 
- - Available configuration commands are:
+    command, which will only ask you about new configuration options.
+
+    Available configuration commands are:
+       "make config"       Text based configuration, no menus or colors.
        "make menuconfig"   Text based color menus, radiolists & dialogs.
        "make oldconfig"    Default all questions based on the contents of
                             your existing ./.config file.
@@ -32,52 +38,48 @@ CONFIGURING uClibc:
        "make allyesconfig" Set all values to "yes" for all options.
        "make allnoconfig"  Set all values to "no" for all options.
 
- - uClibc does not have proper dependancy checking (yet) so if you
-    change your uClibc configuration, you must current rebuild the
-    entire library, by first running 'make clean'.
 
 
 
 COMPILING uClibc:
 
- - Once you have a valid configuration file, just run 'make' to compile 
-    uClibc.  
+ - uClibc does not have proper dependancy checking (yet) so if you
+    change your uClibc configuration, you must current rebuild the
+    entire library, by first running 
+    
+           make clean
 
+ - Once you have a valid configuration file, just run
 
+           make
 
-INSTALLING the uClibc development environment:
+    to compile uClibc.  or if you are cross compiling, you would
+    instead run something like:
 
- - As root, if necessary, run:
+           make CROSS=arm-linux-
 
-       make install
 
-    This will install the header files, libraries, and the gcc wrapper
-    into the directories defined in Config.
 
+INSTALLING the uClibc development environment:
 
-INSTALLING the uClibc target runtime environment:
- - As root, if necessary, run:
+ - As root, if necessary, run something like:
 
-       make PREFIX=<temporary path> install_target
+       make PREFIX=<some path> install
 
-   This will install only the files that are necessary to run
-   binaries compiled against uClibc.  Hint: You probably do not want
-   to install the target runtime environment into /lib on your host
-   machine.
+    This will install the uClibc runtime and development system (i.e.
+    all the header files, libraries, etc) into the directories defined
+    within your .config file.
 
 
 USING uClibc:
  
- - To compile programs with uClibc,
-
-       export PATH={uClibc DEVEL_PREFIX}/bin:$PATH
-
-    and then just run './configure' and 'make' as usual.
-
-Note: 
-
-       You may also want to look at extra/gcc-uclibc/gcc-uclibc.c for
-       additional information concerning what options and environment
-       variables the gcc wrapper handles.
+ - To compile programs with uClibc you will need a complete toolchain
+    (i.e. binutils, gcc, and uClibc) that was built expressly for use
+    with uClibc.
+    
+ - Native and cross compiling toolchains, as well as makefiles for creating
+   uClibc toolchains, are available from the uClibc website.  You may want 
+   to check out "buildroot", which is available from the uClibc download area,
+   which provides examples of how to build your own uClibc based system.
+