Browse Source

README: More consistent and readable white space

Mainly, this just separates paragraphs, so that the text is easier
on the eyes.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Michael Witten 13 years ago
parent
commit
88f7a642cf
1 changed files with 31 additions and 10 deletions
  1. 31 10
      README

+ 31 - 10
README

@@ -65,8 +65,8 @@ INSTALLING the kernel source:
 		gzip -cd linux-3.X.tar.gz | tar xvf -
 		gzip -cd linux-3.X.tar.gz | tar xvf -
 
 
    or
    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.
    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
 		gzip -cd ../patch-3.x.gz | patch -p1
 
 
    or
    or
+
 		bzip2 -dc ../patch-3.x.bz2 | patch -p1
 		bzip2 -dc ../patch-3.x.bz2 | patch -p1
 
 
    Replace "x" for all versions bigger than the version "X" of your current
    Replace "x" for all versions bigger than the version "X" of your current
@@ -142,14 +143,16 @@ BUILD directory for the kernel:
    Using the option "make O=output/dir" allow you to specify an alternate
    Using the option "make O=output/dir" allow you to specify an alternate
    place for the output files (including .config).
    place for the output files (including .config).
    Example:
    Example:
+
      kernel source code:	/usr/src/linux-3.X
      kernel source code:	/usr/src/linux-3.X
      build directory:		/home/name/build/kernel
      build directory:		/home/name/build/kernel
 
 
    To configure and build the kernel, use:
    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
    Please note: If the 'O=output/dir' option is used, then it must be
    used for all invocations of make.
    used for all invocations of make.
@@ -164,36 +167,49 @@ CONFIGURING the kernel:
    only ask you for the answers to new questions.
    only ask you for the answers to new questions.
 
 
  - Alternative configuration commands are:
  - Alternative configuration commands are:
+
 	"make config"      Plain text interface.
 	"make config"      Plain text interface.
+
 	"make menuconfig"  Text based color menus, radiolists & dialogs.
 	"make menuconfig"  Text based color menus, radiolists & dialogs.
+
 	"make nconfig"     Enhanced text based color menus.
 	"make nconfig"     Enhanced text based color menus.
+
 	"make xconfig"     X windows (Qt) based configuration tool.
 	"make xconfig"     X windows (Qt) based configuration tool.
+
 	"make gconfig"     X windows (Gtk) based configuration tool.
 	"make gconfig"     X windows (Gtk) based configuration tool.
+
 	"make oldconfig"   Default all questions based on the contents of
 	"make oldconfig"   Default all questions based on the contents of
 			   your existing ./.config file and asking about
 			   your existing ./.config file and asking about
 			   new config symbols.
 			   new config symbols.
+
 	"make silentoldconfig"
 	"make silentoldconfig"
 			   Like above, but avoids cluttering the screen
 			   Like above, but avoids cluttering the screen
 			   with questions already answered.
 			   with questions already answered.
 			   Additionally updates the dependencies.
 			   Additionally updates the dependencies.
+
 	"make defconfig"   Create a ./.config file by using the default
 	"make defconfig"   Create a ./.config file by using the default
 			   symbol values from either arch/$ARCH/defconfig
 			   symbol values from either arch/$ARCH/defconfig
 			   or arch/$ARCH/configs/${PLATFORM}_defconfig,
 			   or arch/$ARCH/configs/${PLATFORM}_defconfig,
 			   depending on the architecture.
 			   depending on the architecture.
+
 	"make ${PLATFORM}_defconfig"
 	"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"
 	"make allyesconfig"
 			   Create a ./.config file by setting symbol
 			   Create a ./.config file by setting symbol
 			   values to 'y' as much as possible.
 			   values to 'y' as much as possible.
+
 	"make allmodconfig"
 	"make allmodconfig"
 			   Create a ./.config file by setting symbol
 			   Create a ./.config file by setting symbol
 			   values to 'm' as much as possible.
 			   values to 'm' as much as possible.
+
 	"make allnoconfig" Create a ./.config file by setting symbol
 	"make allnoconfig" Create a ./.config file by setting symbol
 			   values to 'n' as much as possible.
 			   values to 'n' as much as possible.
+
 	"make randconfig"  Create a ./.config file by setting symbol
 	"make randconfig"  Create a ./.config file by setting symbol
 			   values to random values.
 			   values to random values.
 
 
@@ -201,17 +217,21 @@ CONFIGURING the kernel:
    in Documentation/kbuild/kconfig.txt.
    in Documentation/kbuild/kconfig.txt.
 
 
 	NOTES on "make config":
 	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
 	  under some circumstances lead to problems: probing for a
 	  nonexistent controller card may confuse your other controllers
 	  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
 	  will result in a kernel that does NOT work on a 386.  The
 	  kernel will detect this on bootup, and give up.
 	  kernel will detect this on bootup, and give up.
+
 	- A kernel with math-emulation compiled in will still use the
 	- A kernel with math-emulation compiled in will still use the
 	  coprocessor if one is present: the math emulation will just
 	  coprocessor if one is present: the math emulation will just
 	  never get used in that case.  The kernel will be slightly larger,
 	  never get used in that case.  The kernel will be slightly larger,
 	  but will work on different machines regardless of whether they
 	  but will work on different machines regardless of whether they
 	  have a math coprocessor or not. 
 	  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
 	  bigger or slower kernel (or both), and can even make the kernel
 	  less stable by configuring some routines to actively try to
 	  less stable by configuring some routines to actively try to
@@ -256,6 +276,7 @@ COMPILING the kernel:
    are installing a new kernel with the same version number as your
    are installing a new kernel with the same version number as your
    working kernel, make a backup of your modules directory before you
    working kernel, make a backup of your modules directory before you
    do a "make modules_install".
    do a "make modules_install".
+
    Alternatively, before compiling, use the kernel config option
    Alternatively, before compiling, use the kernel config option
    "LOCALVERSION" to append a unique suffix to the regular kernel version.
    "LOCALVERSION" to append a unique suffix to the regular kernel version.
    LOCALVERSION can be set in the "General Setup" menu.
    LOCALVERSION can be set in the "General Setup" menu.