README: Capitalize start of sentence
[sfrench/cifs-2.6.git] / README
diff --git a/README b/README
index 0d5a7ddbe3ee8d108bf7079909ddcec30dfb4560..50aa430995b3b6b791a217974cc163a3b2d1f890 100644 (file)
--- a/README
+++ b/README
@@ -65,10 +65,10 @@ 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 "XX" with the version number of the latest kernel.
+   Replace "X" with the version number of the latest kernel.
 
    Do NOT use the /usr/src/linux area! This area has a (usually
    incomplete) set of kernel headers that are used by the library header
@@ -78,18 +78,19 @@ INSTALLING the kernel source:
  - You can also upgrade between 3.x releases by patching.  Patches are
    distributed in the traditional gzip and the newer bzip2 format.  To
    install by patching, get all the newer patch files, enter the
-   top level directory of the kernel source (linux-3.x) and execute:
+   top level directory of the kernel source (linux-3.X) and execute:
 
                gzip -cd ../patch-3.x.gz | patch -p1
 
    or
+
                bzip2 -dc ../patch-3.x.bz2 | patch -p1
 
-   (repeat xx for all versions bigger than the version of your current
-   source tree, _in_order_) and you should be ok.  You may want to remove
-   the backup files (xxx~ or xxx.orig), and make sure that there are no
-   failed patches (xxx# or xxx.rej). If there are, either you or me has
-   made a mistake.
+   Replace "x" for all versions bigger than the version "X" of your current
+   source tree, _in_order_, and you should be ok.  You may want to remove
+   the backup files (some-file-name~ or some-file-name.orig), and make sure
+   that there are no failed patches (some-file-name# or some-file-name.rej).
+   If there are, either you or I have made a mistake.
 
    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
@@ -137,21 +138,23 @@ SOFTWARE REQUIREMENTS
 
 BUILD directory for the kernel:
 
-   When compiling the kernel all output files will per default be
+   When compiling the kernel, all output files will per default be
    stored together with the kernel source code.
    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.N
+
+     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.N
-   make O=/home/name/build/kernel menuconfig
-   make O=/home/name/build/kernel
-   sudo make O=/home/name/build/kernel modules_install install
+   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
 
-   Please note: If the 'O=output/dir' option is used then it must be
+   Please note: If the 'O=output/dir' option is used, then it must be
    used for all invocations of make.
 
 CONFIGURING the kernel:
@@ -163,37 +166,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 +217,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
@@ -230,7 +250,7 @@ COMPILING the kernel:
    possible to do "make install" if you have lilo installed to suit the
    kernel makefiles, but you may want to check your particular lilo setup first.
 
-   To do the actual install you have to be root, but none of the normal
+   To do the actual install, you have to be root, but none of the normal
    build should require that. Don't take the name of root in vain.
 
  - If you configured any of the parts of the kernel as `modules', you
@@ -238,7 +258,7 @@ COMPILING the kernel:
 
  - Verbose kernel compile/build output:
 
-   Normally the kernel build system runs in a fairly quiet mode (but not
+   Normally, the kernel build system runs in a fairly quiet mode (but not
    totally silent).  However, sometimes you or other kernel developers need
    to see compile, link, or other commands exactly as they are executed.
    For this, use "verbose" build mode.  This is done by inserting
@@ -256,6 +276,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.
@@ -267,7 +288,7 @@ COMPILING the kernel:
  - Booting a kernel directly from a floppy without the assistance of a
    bootloader such as LILO, is no longer supported.
 
-   If you boot Linux from the hard drive, chances are you use LILO which
+   If you boot Linux from the hard drive, chances are you use LILO, which
    uses the kernel image as specified in the file /etc/lilo.conf.  The
    kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
    /boot/bzImage.  To use the new kernel, save a copy of the old image
@@ -320,7 +341,7 @@ IF SOMETHING GOES WRONG:
    incomprehensible to you, but it does contain information that may
    help debugging the problem.  The text above the dump is also
    important: it tells something about why the kernel dumped code (in
-   the above example it's due to a bad kernel pointer). More information
+   the above example, it's due to a bad kernel pointer). More information
    on making sense of the dump is in Documentation/oops-tracing.txt
 
  - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
@@ -328,7 +349,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 +382,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").