README: Consolidate discussions of -stable patches
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / README
diff --git a/README b/README
index 9853cadec8cdaf0876c90922d389968bef1ea60f..7333d2b581101de5befc1da1fbda1b0584689a5d 100644 (file)
--- a/README
+++ b/README
@@ -65,8 +65,8 @@ INSTALLING the kernel source:
                gzip -cd linux-3.X.tar.gz | tar xvf -
 
    or
-               bzip2 -dc linux-3.X.tar.bz2 | tar xvf -
 
+               bzip2 -dc linux-3.X.tar.bz2 | tar xvf -
 
    Replace "X" with the version number of the latest kernel.
 
@@ -83,6 +83,7 @@ INSTALLING the kernel source:
                gzip -cd ../patch-3.x.gz | patch -p1
 
    or
+
                bzip2 -dc ../patch-3.x.bz2 | patch -p1
 
    Replace "x" for all versions bigger than the version "X" of your current
@@ -93,8 +94,12 @@ INSTALLING the kernel source:
 
    Unlike patches for the 3.x kernels, patches for the 3.x.y kernels
    (also known as the -stable kernels) are not incremental but instead apply
-   directly to the base 3.x kernel.  Please read
-   Documentation/applying-patches.txt for more information.
+   directly to the base 3.x kernel.  For example, if your base kernel is 3.0
+   and you want to apply the 3.0.3 patch, you must not first apply the 3.0.1
+   and 3.0.2 patches. Similarly, if you are running kernel version 3.0.2 and
+   want to jump to 3.0.3, you must first reverse the 3.0.2 patch (that is,
+   patch -R) _before_ applying the 3.0.3 patch. You can read more on this in
+   Documentation/applying-patches.txt
 
    Alternatively, the script patch-kernel can be used to automate this
    process.  It determines the current kernel version and applies any
@@ -106,17 +111,6 @@ INSTALLING the kernel source:
    kernel source.  Patches are applied from the current directory, but
    an alternative directory can be specified as the second argument.
 
- - If you are upgrading between releases using the stable series patches
-   (for example, patch-3.x.y), note that these "dot-releases" are
-   not incremental and must be applied to the 3.x base tree. For
-   example, if your base kernel is 3.0 and you want to apply the
-   3.0.3 patch, you do not and indeed must not first apply the
-   3.0.1 and 3.0.2 patches. Similarly, if you are running kernel
-   version 3.0.2 and want to jump to 3.0.3, you must first
-   reverse the 3.0.2 patch (that is, patch -R) _before_ applying
-   the 3.0.3 patch.
-   You can read more on this in Documentation/applying-patches.txt
-
  - Make sure you have no stale .o files and dependencies lying around:
 
                cd linux
@@ -142,14 +136,16 @@ BUILD directory for the kernel:
    Using the option "make O=output/dir" allow you to specify an alternate
    place for the output files (including .config).
    Example:
+
      kernel source code:       /usr/src/linux-3.X
      build directory:          /home/name/build/kernel
 
    To configure and build the kernel, use:
-   cd /usr/src/linux-3.X
-   make O=/home/name/build/kernel menuconfig
-   make O=/home/name/build/kernel
-   sudo make O=/home/name/build/kernel modules_install install
+
+     cd /usr/src/linux-3.X
+     make O=/home/name/build/kernel menuconfig
+     make O=/home/name/build/kernel
+     sudo make O=/home/name/build/kernel modules_install install
 
    Please note: If the 'O=output/dir' option is used, then it must be
    used for all invocations of make.
@@ -163,37 +159,50 @@ CONFIGURING the kernel:
    new version with minimal work, use "make oldconfig", which will
    only ask you for the answers to new questions.
 
- - Alternate configuration commands are:
+ - Alternative configuration commands are:
+
        "make config"      Plain text interface.
+
        "make menuconfig"  Text based color menus, radiolists & dialogs.
+
        "make nconfig"     Enhanced text based color menus.
+
        "make xconfig"     X windows (Qt) based configuration tool.
+
        "make gconfig"     X windows (Gtk) based configuration tool.
+
        "make oldconfig"   Default all questions based on the contents of
                           your existing ./.config file and asking about
                           new config symbols.
+
        "make silentoldconfig"
                           Like above, but avoids cluttering the screen
                           with questions already answered.
                           Additionally updates the dependencies.
+
        "make defconfig"   Create a ./.config file by using the default
                           symbol values from either arch/$ARCH/defconfig
                           or arch/$ARCH/configs/${PLATFORM}_defconfig,
                           depending on the architecture.
+
        "make ${PLATFORM}_defconfig"
-                         Create a ./.config file by using the default
-                         symbol values from
-                         arch/$ARCH/configs/${PLATFORM}_defconfig.
-                         Use "make help" to get a list of all available
-                         platforms of your architecture.
+                          Create a ./.config file by using the default
+                          symbol values from
+                          arch/$ARCH/configs/${PLATFORM}_defconfig.
+                          Use "make help" to get a list of all available
+                          platforms of your architecture.
+
        "make allyesconfig"
                           Create a ./.config file by setting symbol
                           values to 'y' as much as possible.
+
        "make allmodconfig"
                           Create a ./.config file by setting symbol
                           values to 'm' as much as possible.
+
        "make allnoconfig" Create a ./.config file by setting symbol
                           values to 'n' as much as possible.
+
        "make randconfig"  Create a ./.config file by setting symbol
                           values to random values.
 
@@ -201,18 +210,22 @@ CONFIGURING the kernel:
    in Documentation/kbuild/kconfig.txt.
 
        NOTES on "make config":
-       - having unnecessary drivers will make the kernel bigger, and can
+
+       - Having unnecessary drivers will make the kernel bigger, and can
          under some circumstances lead to problems: probing for a
          nonexistent controller card may confuse your other controllers
-       - compiling the kernel with "Processor type" set higher than 386
+
+       - Compiling the kernel with "Processor type" set higher than 386
          will result in a kernel that does NOT work on a 386.  The
          kernel will detect this on bootup, and give up.
+
        - A kernel with math-emulation compiled in will still use the
          coprocessor if one is present: the math emulation will just
          never get used in that case.  The kernel will be slightly larger,
          but will work on different machines regardless of whether they
          have a math coprocessor or not. 
-       - the "kernel hacking" configuration details usually result in a
+
+       - The "kernel hacking" configuration details usually result in a
          bigger or slower kernel (or both), and can even make the kernel
          less stable by configuring some routines to actively try to
          break bad code to find kernel problems (kmalloc()).  Thus you
@@ -256,6 +269,7 @@ COMPILING the kernel:
    are installing a new kernel with the same version number as your
    working kernel, make a backup of your modules directory before you
    do a "make modules_install".
+
    Alternatively, before compiling, use the kernel config option
    "LOCALVERSION" to append a unique suffix to the regular kernel version.
    LOCALVERSION can be set in the "General Setup" menu.
@@ -328,7 +342,7 @@ IF SOMETHING GOES WRONG:
    sense of the dump (but compiling with CONFIG_KALLSYMS is usually preferred).
    This utility can be downloaded from
    ftp://ftp.<country>.kernel.org/pub/linux/utils/kernel/ksymoops/ .
-   Alternately, you can do the dump lookup by hand:
+   Alternatively, you can do the dump lookup by hand:
 
  - In debugging dumps like the above, it helps enormously if you can
    look up what the EIP value means.  The hex value as such doesn't help
@@ -361,7 +375,7 @@ IF SOMETHING GOES WRONG:
    kernel image or similar), telling me as much about your setup as
    possible will help.  Please read the REPORTING-BUGS document for details.
 
- - Alternately, you can use gdb on a running kernel. (read-only; i.e. you
+ - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
    cannot change values or set break points.) To do this, first compile the
    kernel with -g; edit arch/i386/Makefile appropriately, then do a "make
    clean". You'll also need to enable CONFIG_PROC_FS (via "make config").