~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/admin-guide/README.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /Documentation/admin-guide/README.rst (Version linux-6.12-rc7) and /Documentation/admin-guide/README.rst (Version linux-4.16.18)


  1 .. _readme:                                    !!   1 Linux kernel release 4.x <http://kernel.org/>
  2                                                << 
  3 Linux kernel release 6.x <http://kernel.org/>  << 
  4 =============================================       2 =============================================
  5                                                     3 
  6 These are the release notes for Linux version  !!   4 These are the release notes for Linux version 4.  Read them carefully,
  7 as they tell you what this is all about, expla      5 as they tell you what this is all about, explain how to install the
  8 kernel, and what to do if something goes wrong      6 kernel, and what to do if something goes wrong.
  9                                                     7 
 10 What is Linux?                                      8 What is Linux?
 11 --------------                                      9 --------------
 12                                                    10 
 13   Linux is a clone of the operating system Uni     11   Linux is a clone of the operating system Unix, written from scratch by
 14   Linus Torvalds with assistance from a loosel     12   Linus Torvalds with assistance from a loosely-knit team of hackers across
 15   the Net. It aims towards POSIX and Single UN     13   the Net. It aims towards POSIX and Single UNIX Specification compliance.
 16                                                    14 
 17   It has all the features you would expect in      15   It has all the features you would expect in a modern fully-fledged Unix,
 18   including true multitasking, virtual memory,     16   including true multitasking, virtual memory, shared libraries, demand
 19   loading, shared copy-on-write executables, p     17   loading, shared copy-on-write executables, proper memory management,
 20   and multistack networking including IPv4 and     18   and multistack networking including IPv4 and IPv6.
 21                                                    19 
 22   It is distributed under the GNU General Publ     20   It is distributed under the GNU General Public License v2 - see the
 23   accompanying COPYING file for more details.      21   accompanying COPYING file for more details.
 24                                                    22 
 25 On what hardware does it run?                      23 On what hardware does it run?
 26 -----------------------------                      24 -----------------------------
 27                                                    25 
 28   Although originally developed first for 32-b     26   Although originally developed first for 32-bit x86-based PCs (386 or higher),
 29   today Linux also runs on (at least) the Comp     27   today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
 30   UltraSPARC, Motorola 68000, PowerPC, PowerPC     28   UltraSPARC, Motorola 68000, PowerPC, PowerPC64, ARM, Hitachi SuperH, Cell,
 31   IBM S/390, MIPS, HP PA-RISC, Intel IA-64, DE !!  29   IBM S/390, MIPS, HP PA-RISC, Intel IA-64, DEC VAX, AMD x86-64, AXIS CRIS,
 32   ARC architectures.                           !!  30   Xtensa, Tilera TILE, ARC and Renesas M32R architectures.
 33                                                    31 
 34   Linux is easily portable to most general-pur     32   Linux is easily portable to most general-purpose 32- or 64-bit architectures
 35   as long as they have a paged memory manageme     33   as long as they have a paged memory management unit (PMMU) and a port of the
 36   GNU C compiler (gcc) (part of The GNU Compil     34   GNU C compiler (gcc) (part of The GNU Compiler Collection, GCC). Linux has
 37   also been ported to a number of architecture     35   also been ported to a number of architectures without a PMMU, although
 38   functionality is then obviously somewhat lim     36   functionality is then obviously somewhat limited.
 39   Linux has also been ported to itself. You ca     37   Linux has also been ported to itself. You can now run the kernel as a
 40   userspace application - this is called UserM     38   userspace application - this is called UserMode Linux (UML).
 41                                                    39 
 42 Documentation                                      40 Documentation
 43 -------------                                      41 -------------
 44                                                    42 
 45  - There is a lot of documentation available b     43  - There is a lot of documentation available both in electronic form on
 46    the Internet and in books, both Linux-speci     44    the Internet and in books, both Linux-specific and pertaining to
 47    general UNIX questions.  I'd recommend look     45    general UNIX questions.  I'd recommend looking into the documentation
 48    subdirectories on any Linux FTP site for th     46    subdirectories on any Linux FTP site for the LDP (Linux Documentation
 49    Project) books.  This README is not meant t     47    Project) books.  This README is not meant to be documentation on the
 50    system: there are much better sources avail     48    system: there are much better sources available.
 51                                                    49 
 52  - There are various README files in the Docum     50  - There are various README files in the Documentation/ subdirectory:
 53    these typically contain kernel-specific ins     51    these typically contain kernel-specific installation notes for some
 54    drivers for example. Please read the        !!  52    drivers for example. See Documentation/00-INDEX for a list of what
                                                   >>  53    is contained in each file.  Please read the
 55    :ref:`Documentation/process/changes.rst <ch     54    :ref:`Documentation/process/changes.rst <changes>` file, as it
 56    contains information about the problems, wh     55    contains information about the problems, which may result by upgrading
 57    your kernel.                                    56    your kernel.
 58                                                    57 
 59 Installing the kernel source                       58 Installing the kernel source
 60 ----------------------------                       59 ----------------------------
 61                                                    60 
 62  - If you install the full sources, put the ke     61  - If you install the full sources, put the kernel tarball in a
 63    directory where you have permissions (e.g.      62    directory where you have permissions (e.g. your home directory) and
 64    unpack it::                                     63    unpack it::
 65                                                    64 
 66      xz -cd linux-6.x.tar.xz | tar xvf -       !!  65      xz -cd linux-4.X.tar.xz | tar xvf -
 67                                                    66 
 68    Replace "X" with the version number of the      67    Replace "X" with the version number of the latest kernel.
 69                                                    68 
 70    Do NOT use the /usr/src/linux area! This ar     69    Do NOT use the /usr/src/linux area! This area has a (usually
 71    incomplete) set of kernel headers that are      70    incomplete) set of kernel headers that are used by the library header
 72    files.  They should match the library, and      71    files.  They should match the library, and not get messed up by
 73    whatever the kernel-du-jour happens to be.      72    whatever the kernel-du-jour happens to be.
 74                                                    73 
 75  - You can also upgrade between 6.x releases b !!  74  - You can also upgrade between 4.x releases by patching.  Patches are
 76    distributed in the xz format.  To install b     75    distributed in the xz format.  To install by patching, get all the
 77    newer patch files, enter the top level dire     76    newer patch files, enter the top level directory of the kernel source
 78    (linux-6.x) and execute::                   !!  77    (linux-4.X) and execute::
 79                                                    78 
 80      xz -cd ../patch-6.x.xz | patch -p1        !!  79      xz -cd ../patch-4.x.xz | patch -p1
 81                                                    80 
 82    Replace "x" for all versions bigger than th !!  81    Replace "x" for all versions bigger than the version "X" of your current
 83    source tree, **in_order**, and you should b     82    source tree, **in_order**, and you should be ok.  You may want to remove
 84    the backup files (some-file-name~ or some-f     83    the backup files (some-file-name~ or some-file-name.orig), and make sure
 85    that there are no failed patches (some-file     84    that there are no failed patches (some-file-name# or some-file-name.rej).
 86    If there are, either you or I have made a m     85    If there are, either you or I have made a mistake.
 87                                                    86 
 88    Unlike patches for the 6.x kernels, patches !!  87    Unlike patches for the 4.x kernels, patches for the 4.x.y kernels
 89    (also known as the -stable kernels) are not     88    (also known as the -stable kernels) are not incremental but instead apply
 90    directly to the base 6.x kernel.  For examp !!  89    directly to the base 4.x kernel.  For example, if your base kernel is 4.0
 91    and you want to apply the 6.0.3 patch, you  !!  90    and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
 92    and 6.0.2 patches. Similarly, if you are ru !!  91    and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
 93    want to jump to 6.0.3, you must first rever !!  92    want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
 94    patch -R) **before** applying the 6.0.3 pat !!  93    patch -R) **before** applying the 4.0.3 patch. You can read more on this in
 95    :ref:`Documentation/process/applying-patche     94    :ref:`Documentation/process/applying-patches.rst <applying_patches>`.
 96                                                    95 
 97    Alternatively, the script patch-kernel can      96    Alternatively, the script patch-kernel can be used to automate this
 98    process.  It determines the current kernel      97    process.  It determines the current kernel version and applies any
 99    patches found::                                 98    patches found::
100                                                    99 
101      linux/scripts/patch-kernel linux             100      linux/scripts/patch-kernel linux
102                                                   101 
103    The first argument in the command above is     102    The first argument in the command above is the location of the
104    kernel source.  Patches are applied from th    103    kernel source.  Patches are applied from the current directory, but
105    an alternative directory can be specified a    104    an alternative directory can be specified as the second argument.
106                                                   105 
107  - Make sure you have no stale .o files and de    106  - Make sure you have no stale .o files and dependencies lying around::
108                                                   107 
109      cd linux                                     108      cd linux
110      make mrproper                                109      make mrproper
111                                                   110 
112    You should now have the sources correctly i    111    You should now have the sources correctly installed.
113                                                   112 
114 Software requirements                             113 Software requirements
115 ---------------------                             114 ---------------------
116                                                   115 
117    Compiling and running the 6.x kernels requi !! 116    Compiling and running the 4.x kernels requires up-to-date
118    versions of various software packages.  Con    117    versions of various software packages.  Consult
119    :ref:`Documentation/process/changes.rst <ch    118    :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
120    required and how to get updates for these p    119    required and how to get updates for these packages.  Beware that using
121    excessively old versions of these packages     120    excessively old versions of these packages can cause indirect
122    errors that are very difficult to track dow    121    errors that are very difficult to track down, so don't assume that
123    you can just update packages when obvious p    122    you can just update packages when obvious problems arise during
124    build or operation.                            123    build or operation.
125                                                   124 
126 Build directory for the kernel                    125 Build directory for the kernel
127 ------------------------------                    126 ------------------------------
128                                                   127 
129    When compiling the kernel, all output files    128    When compiling the kernel, all output files will per default be
130    stored together with the kernel source code    129    stored together with the kernel source code.
131    Using the option ``make O=output/dir`` allo    130    Using the option ``make O=output/dir`` allows you to specify an alternate
132    place for the output files (including .conf    131    place for the output files (including .config).
133    Example::                                      132    Example::
134                                                   133 
135      kernel source code: /usr/src/linux-6.x    !! 134      kernel source code: /usr/src/linux-4.X
136      build directory:    /home/name/build/kern    135      build directory:    /home/name/build/kernel
137                                                   136 
138    To configure and build the kernel, use::       137    To configure and build the kernel, use::
139                                                   138 
140      cd /usr/src/linux-6.x                     !! 139      cd /usr/src/linux-4.X
141      make O=/home/name/build/kernel menuconfig    140      make O=/home/name/build/kernel menuconfig
142      make O=/home/name/build/kernel               141      make O=/home/name/build/kernel
143      sudo make O=/home/name/build/kernel modul    142      sudo make O=/home/name/build/kernel modules_install install
144                                                   143 
145    Please note: If the ``O=output/dir`` option    144    Please note: If the ``O=output/dir`` option is used, then it must be
146    used for all invocations of make.              145    used for all invocations of make.
147                                                   146 
148 Configuring the kernel                            147 Configuring the kernel
149 ----------------------                            148 ----------------------
150                                                   149 
151    Do not skip this step even if you are only     150    Do not skip this step even if you are only upgrading one minor
152    version.  New configuration options are add    151    version.  New configuration options are added in each release, and
153    odd problems will turn up if the configurat    152    odd problems will turn up if the configuration files are not set up
154    as expected.  If you want to carry your exi    153    as expected.  If you want to carry your existing configuration to a
155    new version with minimal work, use ``make o    154    new version with minimal work, use ``make oldconfig``, which will
156    only ask you for the answers to new questio    155    only ask you for the answers to new questions.
157                                                   156 
158  - Alternative configuration commands are::       157  - Alternative configuration commands are::
159                                                   158 
160      "make config"      Plain text interface.     159      "make config"      Plain text interface.
161                                                   160 
162      "make menuconfig"  Text based color menus    161      "make menuconfig"  Text based color menus, radiolists & dialogs.
163                                                   162 
164      "make nconfig"     Enhanced text based co    163      "make nconfig"     Enhanced text based color menus.
165                                                   164 
166      "make xconfig"     Qt based configuration    165      "make xconfig"     Qt based configuration tool.
167                                                   166 
168      "make gconfig"     GTK+ based configurati    167      "make gconfig"     GTK+ based configuration tool.
169                                                   168 
170      "make oldconfig"   Default all questions     169      "make oldconfig"   Default all questions based on the contents of
171                         your existing ./.confi    170                         your existing ./.config file and asking about
172                         new config symbols.       171                         new config symbols.
173                                                   172 
174      "make olddefconfig"                          173      "make olddefconfig"
175                         Like above, but sets n    174                         Like above, but sets new symbols to their default
176                         values without prompti    175                         values without prompting.
177                                                   176 
178      "make defconfig"   Create a ./.config fil    177      "make defconfig"   Create a ./.config file by using the default
179                         symbol values from eit    178                         symbol values from either arch/$ARCH/defconfig
180                         or arch/$ARCH/configs/    179                         or arch/$ARCH/configs/${PLATFORM}_defconfig,
181                         depending on the archi    180                         depending on the architecture.
182                                                   181 
183      "make ${PLATFORM}_defconfig"                 182      "make ${PLATFORM}_defconfig"
184                         Create a ./.config fil    183                         Create a ./.config file by using the default
185                         symbol values from        184                         symbol values from
186                         arch/$ARCH/configs/${P    185                         arch/$ARCH/configs/${PLATFORM}_defconfig.
187                         Use "make help" to get    186                         Use "make help" to get a list of all available
188                         platforms of your arch    187                         platforms of your architecture.
189                                                   188 
190      "make allyesconfig"                          189      "make allyesconfig"
191                         Create a ./.config fil    190                         Create a ./.config file by setting symbol
192                         values to 'y' as much     191                         values to 'y' as much as possible.
193                                                   192 
194      "make allmodconfig"                          193      "make allmodconfig"
195                         Create a ./.config fil    194                         Create a ./.config file by setting symbol
196                         values to 'm' as much     195                         values to 'm' as much as possible.
197                                                   196 
198      "make allnoconfig" Create a ./.config fil    197      "make allnoconfig" Create a ./.config file by setting symbol
199                         values to 'n' as much     198                         values to 'n' as much as possible.
200                                                   199 
201      "make randconfig"  Create a ./.config fil    200      "make randconfig"  Create a ./.config file by setting symbol
202                         values to random value    201                         values to random values.
203                                                   202 
204      "make localmodconfig" Create a config bas    203      "make localmodconfig" Create a config based on current config and
205                            loaded modules (lsm    204                            loaded modules (lsmod). Disables any module
206                            option that is not     205                            option that is not needed for the loaded modules.
207                                                   206 
208                            To create a localmo    207                            To create a localmodconfig for another machine,
209                            store the lsmod of     208                            store the lsmod of that machine into a file
210                            and pass it in as a    209                            and pass it in as a LSMOD parameter.
211                                                   210 
212                            Also, you can prese << 
213                            or kconfig files by << 
214                            parameter LMC_KEEP. << 
215                                                << 
216                    target$ lsmod > /tmp/mylsmo    211                    target$ lsmod > /tmp/mylsmod
217                    target$ scp /tmp/mylsmod ho    212                    target$ scp /tmp/mylsmod host:/tmp
218                                                   213 
219                    host$ make LSMOD=/tmp/mylsm !! 214                    host$ make LSMOD=/tmp/mylsmod localmodconfig
220                            LMC_KEEP="drivers/u << 
221                            localmodconfig      << 
222                                                   215 
223                            The above also work    216                            The above also works when cross compiling.
224                                                   217 
225      "make localyesconfig" Similar to localmod    218      "make localyesconfig" Similar to localmodconfig, except it will convert
226                            all module options  !! 219                            all module options to built in (=y) options.
227                            also preserve modul << 
228                                                << 
229      "make kvm_guest.config"   Enable addition << 
230                                support.        << 
231                                                << 
232      "make xen.config"   Enable additional opt << 
233                          support.              << 
234                                                << 
235      "make tinyconfig"  Configure the tiniest  << 
236                                                   220 
237    You can find more information on using the     221    You can find more information on using the Linux kernel config tools
238    in Documentation/kbuild/kconfig.rst.        !! 222    in Documentation/kbuild/kconfig.txt.
239                                                   223 
240  - NOTES on ``make config``:                      224  - NOTES on ``make config``:
241                                                   225 
242     - Having unnecessary drivers will make the    226     - Having unnecessary drivers will make the kernel bigger, and can
243       under some circumstances lead to problem    227       under some circumstances lead to problems: probing for a
244       nonexistent controller card may confuse     228       nonexistent controller card may confuse your other controllers.
245                                                   229 
246     - A kernel with math-emulation compiled in    230     - A kernel with math-emulation compiled in will still use the
247       coprocessor if one is present: the math     231       coprocessor if one is present: the math emulation will just
248       never get used in that case.  The kernel    232       never get used in that case.  The kernel will be slightly larger,
249       but will work on different machines rega    233       but will work on different machines regardless of whether they
250       have a math coprocessor or not.             234       have a math coprocessor or not.
251                                                   235 
252     - The "kernel hacking" configuration detai    236     - The "kernel hacking" configuration details usually result in a
253       bigger or slower kernel (or both), and c    237       bigger or slower kernel (or both), and can even make the kernel
254       less stable by configuring some routines    238       less stable by configuring some routines to actively try to
255       break bad code to find kernel problems (    239       break bad code to find kernel problems (kmalloc()).  Thus you
256       should probably answer 'n' to the questi    240       should probably answer 'n' to the questions for "development",
257       "experimental", or "debugging" features.    241       "experimental", or "debugging" features.
258                                                   242 
259 Compiling the kernel                              243 Compiling the kernel
260 --------------------                              244 --------------------
261                                                   245 
262  - Make sure you have at least gcc 5.1 availab !! 246  - Make sure you have at least gcc 3.2 available.
263    For more information, refer to :ref:`Docume    247    For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
264                                                   248 
265  - Do a ``make`` to create a compressed kernel !! 249    Please note that you can still run a.out user programs with this kernel.
266    ``make install`` if you have lilo installed !! 250 
267    install script recognised by the kernel's i !! 251  - Do a ``make`` to create a compressed kernel image. It is also
268    distributions will have a recognized instal !! 252    possible to do ``make install`` if you have lilo installed to suit the
269    check your distribution's setup first.      !! 253    kernel makefiles, but you may want to check your particular lilo setup first.
270                                                   254 
271    To do the actual install, you have to be ro    255    To do the actual install, you have to be root, but none of the normal
272    build should require that. Don't take the n    256    build should require that. Don't take the name of root in vain.
273                                                   257 
274  - If you configured any of the parts of the k    258  - If you configured any of the parts of the kernel as ``modules``, you
275    will also have to do ``make modules_install    259    will also have to do ``make modules_install``.
276                                                   260 
277  - Verbose kernel compile/build output:           261  - Verbose kernel compile/build output:
278                                                   262 
279    Normally, the kernel build system runs in a    263    Normally, the kernel build system runs in a fairly quiet mode (but not
280    totally silent).  However, sometimes you or    264    totally silent).  However, sometimes you or other kernel developers need
281    to see compile, link, or other commands exa    265    to see compile, link, or other commands exactly as they are executed.
282    For this, use "verbose" build mode.  This i    266    For this, use "verbose" build mode.  This is done by passing
283    ``V=1`` to the ``make`` command, e.g.::        267    ``V=1`` to the ``make`` command, e.g.::
284                                                   268 
285      make V=1 all                                 269      make V=1 all
286                                                   270 
287    To have the build system also tell the reas    271    To have the build system also tell the reason for the rebuild of each
288    target, use ``V=2``.  The default is ``V=0`    272    target, use ``V=2``.  The default is ``V=0``.
289                                                   273 
290  - Keep a backup kernel handy in case somethin    274  - Keep a backup kernel handy in case something goes wrong.  This is
291    especially true for the development release    275    especially true for the development releases, since each new release
292    contains new code which has not been debugg    276    contains new code which has not been debugged.  Make sure you keep a
293    backup of the modules corresponding to that    277    backup of the modules corresponding to that kernel, as well.  If you
294    are installing a new kernel with the same v    278    are installing a new kernel with the same version number as your
295    working kernel, make a backup of your modul    279    working kernel, make a backup of your modules directory before you
296    do a ``make modules_install``.                 280    do a ``make modules_install``.
297                                                   281 
298    Alternatively, before compiling, use the ke    282    Alternatively, before compiling, use the kernel config option
299    "LOCALVERSION" to append a unique suffix to    283    "LOCALVERSION" to append a unique suffix to the regular kernel version.
300    LOCALVERSION can be set in the "General Set    284    LOCALVERSION can be set in the "General Setup" menu.
301                                                   285 
302  - In order to boot your new kernel, you'll ne    286  - In order to boot your new kernel, you'll need to copy the kernel
303    image (e.g. .../linux/arch/x86/boot/bzImage    287    image (e.g. .../linux/arch/x86/boot/bzImage after compilation)
304    to the place where your regular bootable ke    288    to the place where your regular bootable kernel is found.
305                                                   289 
306  - Booting a kernel directly from a storage de !! 290  - Booting a kernel directly from a floppy without the assistance of a
307    of a bootloader such as LILO or GRUB, is no !! 291    bootloader such as LILO, is no longer supported.
308    (non-EFI systems). On UEFI/EFI systems, how << 
309    which allows the motherboard to boot direct << 
310    On modern workstations and desktops, it's g << 
311    bootloader as difficulties can arise with m << 
312    For more details on EFISTUB,                << 
313    see "Documentation/admin-guide/efi-stub.rst << 
314                                                << 
315  - It's important to note that as of 2016 LILO << 
316    active development, though as it was extrem << 
317    in documentation. Popular alternatives incl << 
318    systemd-boot, or EFISTUB. For various reaso << 
319    software that's no longer in active develop << 
320                                                << 
321  - Chances are your distribution includes an i << 
322    ``make install`` will be all that's needed. << 
323    you'll have to identify your bootloader and << 
324    configure your EFI.                         << 
325                                                << 
326 Legacy LILO Instructions                       << 
327 ------------------------                       << 
328                                                << 
329                                                << 
330  - If you use LILO the kernel images are speci << 
331    The kernel image file is usually /vmlinuz,  << 
332    /boot/bzImage. To use the new kernel, save  << 
333    the new image over the old one. Then, you M << 
334    loading map! If you don't, you won't be abl << 
335                                                << 
336  - Reinstalling LILO is usually a matter of ru << 
337    to edit /etc/lilo.conf to specify an entry  << 
338    (say, /vmlinux.old) in case the new one doe << 
339    for more information.                       << 
340                                                   292 
341  - After reinstalling LILO, you should be all  !! 293    If you boot Linux from the hard drive, chances are you use LILO, which
                                                   >> 294    uses the kernel image as specified in the file /etc/lilo.conf.  The
                                                   >> 295    kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
                                                   >> 296    /boot/bzImage.  To use the new kernel, save a copy of the old image
                                                   >> 297    and copy the new image over the old one.  Then, you MUST RERUN LILO
                                                   >> 298    to update the loading map! If you don't, you won't be able to boot
                                                   >> 299    the new kernel image.
                                                   >> 300 
                                                   >> 301    Reinstalling LILO is usually a matter of running /sbin/lilo.
                                                   >> 302    You may wish to edit /etc/lilo.conf to specify an entry for your
                                                   >> 303    old kernel image (say, /vmlinux.old) in case the new one does not
                                                   >> 304    work.  See the LILO docs for more information.
                                                   >> 305 
                                                   >> 306    After reinstalling LILO, you should be all set.  Shutdown the system,
342    reboot, and enjoy!                             307    reboot, and enjoy!
343                                                   308 
344  - If you ever need to change the default root !! 309    If you ever need to change the default root device, video mode,
345    kernel image, use your bootloader's boot op !! 310    ramdisk size, etc.  in the kernel image, use the ``rdev`` program (or
346    to recompile the kernel to change these par !! 311    alternatively the LILO boot options when appropriate).  No need to
                                                   >> 312    recompile the kernel to change these parameters.
347                                                   313 
348  - Reboot with the new kernel and enjoy.          314  - Reboot with the new kernel and enjoy.
349                                                   315 
350                                                << 
351 If something goes wrong                           316 If something goes wrong
352 -----------------------                           317 -----------------------
353                                                   318 
354 If you have problems that seem to be due to ke !! 319  - If you have problems that seem to be due to kernel bugs, please check
355 instructions at 'Documentation/admin-guide/rep !! 320    the file MAINTAINERS to see if there is a particular person associated
                                                   >> 321    with the part of the kernel that you are having trouble with. If there
                                                   >> 322    isn't anyone listed there, then the second best thing is to mail
                                                   >> 323    them to me (torvalds@linux-foundation.org), and possibly to any other
                                                   >> 324    relevant mailing-list or to the newsgroup.
                                                   >> 325 
                                                   >> 326  - In all bug-reports, *please* tell what kernel you are talking about,
                                                   >> 327    how to duplicate the problem, and what your setup is (use your common
                                                   >> 328    sense).  If the problem is new, tell me so, and if the problem is
                                                   >> 329    old, please try to tell me when you first noticed it.
                                                   >> 330 
                                                   >> 331  - If the bug results in a message like::
                                                   >> 332 
                                                   >> 333      unable to handle kernel paging request at address C0000010
                                                   >> 334      Oops: 0002
                                                   >> 335      EIP:   0010:XXXXXXXX
                                                   >> 336      eax: xxxxxxxx   ebx: xxxxxxxx   ecx: xxxxxxxx   edx: xxxxxxxx
                                                   >> 337      esi: xxxxxxxx   edi: xxxxxxxx   ebp: xxxxxxxx
                                                   >> 338      ds: xxxx  es: xxxx  fs: xxxx  gs: xxxx
                                                   >> 339      Pid: xx, process nr: xx
                                                   >> 340      xx xx xx xx xx xx xx xx xx xx
                                                   >> 341 
                                                   >> 342    or similar kernel debugging information on your screen or in your
                                                   >> 343    system log, please duplicate it *exactly*.  The dump may look
                                                   >> 344    incomprehensible to you, but it does contain information that may
                                                   >> 345    help debugging the problem.  The text above the dump is also
                                                   >> 346    important: it tells something about why the kernel dumped code (in
                                                   >> 347    the above example, it's due to a bad kernel pointer). More information
                                                   >> 348    on making sense of the dump is in Documentation/admin-guide/bug-hunting.rst
                                                   >> 349 
                                                   >> 350  - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
                                                   >> 351    as is, otherwise you will have to use the ``ksymoops`` program to make
                                                   >> 352    sense of the dump (but compiling with CONFIG_KALLSYMS is usually preferred).
                                                   >> 353    This utility can be downloaded from
                                                   >> 354    https://www.kernel.org/pub/linux/utils/kernel/ksymoops/ .
                                                   >> 355    Alternatively, you can do the dump lookup by hand:
                                                   >> 356 
                                                   >> 357  - In debugging dumps like the above, it helps enormously if you can
                                                   >> 358    look up what the EIP value means.  The hex value as such doesn't help
                                                   >> 359    me or anybody else very much: it will depend on your particular
                                                   >> 360    kernel setup.  What you should do is take the hex value from the EIP
                                                   >> 361    line (ignore the ``0010:``), and look it up in the kernel namelist to
                                                   >> 362    see which kernel function contains the offending address.
                                                   >> 363 
                                                   >> 364    To find out the kernel function name, you'll need to find the system
                                                   >> 365    binary associated with the kernel that exhibited the symptom.  This is
                                                   >> 366    the file 'linux/vmlinux'.  To extract the namelist and match it against
                                                   >> 367    the EIP from the kernel crash, do::
                                                   >> 368 
                                                   >> 369      nm vmlinux | sort | less
                                                   >> 370 
                                                   >> 371    This will give you a list of kernel addresses sorted in ascending
                                                   >> 372    order, from which it is simple to find the function that contains the
                                                   >> 373    offending address.  Note that the address given by the kernel
                                                   >> 374    debugging messages will not necessarily match exactly with the
                                                   >> 375    function addresses (in fact, that is very unlikely), so you can't
                                                   >> 376    just 'grep' the list: the list will, however, give you the starting
                                                   >> 377    point of each kernel function, so by looking for the function that
                                                   >> 378    has a starting address lower than the one you are searching for but
                                                   >> 379    is followed by a function with a higher address you will find the one
                                                   >> 380    you want.  In fact, it may be a good idea to include a bit of
                                                   >> 381    "context" in your problem report, giving a few lines around the
                                                   >> 382    interesting one.
                                                   >> 383 
                                                   >> 384    If you for some reason cannot do the above (you have a pre-compiled
                                                   >> 385    kernel image or similar), telling me as much about your setup as
                                                   >> 386    possible will help.  Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
                                                   >> 387    document for details.
                                                   >> 388 
                                                   >> 389  - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
                                                   >> 390    cannot change values or set break points.) To do this, first compile the
                                                   >> 391    kernel with -g; edit arch/x86/Makefile appropriately, then do a ``make
                                                   >> 392    clean``. You'll also need to enable CONFIG_PROC_FS (via ``make config``).
                                                   >> 393 
                                                   >> 394    After you've rebooted with the new kernel, do ``gdb vmlinux /proc/kcore``.
                                                   >> 395    You can now use all the usual gdb commands. The command to look up the
                                                   >> 396    point where your system crashed is ``l *0xXXXXXXXX``. (Replace the XXXes
                                                   >> 397    with the EIP value.)
356                                                   398 
357 Hints on understanding kernel bug reports are  !! 399    gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
358 'Documentation/admin-guide/bug-hunting.rst'. M !! 400    disregards the starting offset for which the kernel is compiled.
359 with gdb is in 'Documentation/dev-tools/gdb-ke << 
360 'Documentation/dev-tools/kgdb.rst'.            << 
                                                      

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php