Changes 12.6 KB
Newer Older
1 2
.. _changes:

3 4 5
Minimal requerements to compile the Kernel
++++++++++++++++++++++++++++++++++++++++++

Linus Torvalds's avatar
Linus Torvalds committed
6 7 8 9
Intro
=====

This document is designed to provide a list of the minimum levels of
10
software necessary to run the 4.x kernels.
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17

This document is originally based on my "Changes" file for 2.0.x kernels
and therefore owes credit to the same people as that file (Jared Mauch,
Axel Boldt, Alessandro Sigala, and countless other users all over the
'net).

Current Minimal Requirements
18
****************************
Linus Torvalds's avatar
Linus Torvalds committed
19

20
Upgrade to at **least** these software revisions before thinking you've
Linus Torvalds's avatar
Linus Torvalds committed
21 22 23
encountered a bug!  If you're unsure what version you're currently
running, the suggested command should tell you.

24 25 26 27
Again, keep in mind that this list assumes you are already functionally
running a Linux kernel.  Also, not all tools are necessary on all
systems; obviously, if you don't have any ISDN hardware, for example,
you probably needn't concern yourself with isdn4k-utils.
Linus Torvalds's avatar
Linus Torvalds committed
28

29 30 31 32 33 34 35
====================== ===============  ========================================
        Program        Minimal version       Command to check the version
====================== ===============  ========================================
GNU C                  3.2              gcc --version
GNU make               3.80             make --version
binutils               2.12             ld -v
util-linux             2.10o            fdformat --version
36
kmod                   13               depmod -V
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
e2fsprogs              1.41.4           e2fsck -V
jfsutils               1.1.3            fsck.jfs -V
reiserfsprogs          3.6.3            reiserfsck -V
xfsprogs               2.6.0            xfs_db -V
squashfs-tools         4.0              mksquashfs -version
btrfs-progs            0.18             btrfsck
pcmciautils            004              pccardctl -V
quota-tools            3.09             quota -V
PPP                    2.4.0            pppd --version
isdn4k-utils           3.1pre1          isdnctrl 2>&1|grep version
nfs-utils              1.0.5            showmount --version
procps                 3.2.0            ps --version
oprofile               0.9              oprofiled --version
udev                   081              udevd --version
grub                   0.93             grub --version || grub-install --version
mcelog                 0.6              mcelog --version
iptables               1.4.2            iptables -V
openssl & libcrypto    1.0.0            openssl version
bc                     1.06.95          bc --version
56
Sphinx\ [#f1]_	       1.2		sphinx-build --version
57
====================== ===============  ========================================
58

59
.. [#f1] Sphinx is needed only to build the Kernel documentation
Linus Torvalds's avatar
Linus Torvalds committed
60 61

Kernel compilation
62
******************
Linus Torvalds's avatar
Linus Torvalds committed
63 64 65 66 67

GCC
---

The gcc version requirements may vary depending on the type of CPU in your
68
computer.
Linus Torvalds's avatar
Linus Torvalds committed
69 70 71 72

Make
----

73
You will need GNU make 3.80 or later to build the kernel.
Linus Torvalds's avatar
Linus Torvalds committed
74 75 76 77

Binutils
--------

78 79
Linux on IA-32 has recently switched from using ``as86`` to using ``gas`` for
assembling the 16-bit boot code, removing the need for ``as86`` to compile
Linus Torvalds's avatar
Linus Torvalds committed
80 81 82
your kernel.  This change does, however, mean that you need a recent
release of binutils.

83 84 85
Perl
----

86 87
You will need perl 5 and the following modules: ``Getopt::Long``,
``Getopt::Std``, ``File::Basename``, and ``File::Find`` to build the kernel.
88

89 90 91 92 93
BC
--

You will need bc to build kernels 3.10 and higher

94

95 96 97 98 99 100 101 102 103 104 105
OpenSSL
-------

Module signing and external certificate handling use the OpenSSL program and
crypto library to do key creation and signature generation.

You will need openssl to build kernels 3.7 and higher if module signing is
enabled.  You will also need openssl development packages to build kernels 4.3
and higher.


Linus Torvalds's avatar
Linus Torvalds committed
106
System utilities
107
****************
Linus Torvalds's avatar
Linus Torvalds committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

Architectural changes
---------------------

DevFS has been obsoleted in favour of udev
(http://www.kernel.org/pub/linux/utils/kernel/hotplug/)

32-bit UID support is now in place.  Have fun!

Linux documentation for functions is transitioning to inline
documentation via specially-formatted comments near their
definitions in the source.  These comments can be combined with the
SGML templates in the Documentation/DocBook directory to make DocBook
files, which can then be converted by DocBook stylesheets to PostScript,
HTML, PDF files, and several other formats.  In order to convert from
DocBook format to a format of your choice, you'll need to install Jade as
well as the desired DocBook stylesheets.

Util-linux
----------

129
New versions of util-linux provide ``fdisk`` support for larger disks,
Linus Torvalds's avatar
Linus Torvalds committed
130 131 132 133 134 135 136
support new options to mount, recognize more supported partition
types, have a fdformat which works with 2.4 kernels, and similar goodies.
You'll probably want to upgrade.

Ksymoops
--------

137 138
If the unthinkable happens and your kernel oopses, you may need the
ksymoops tool to decode it, but in most cases you don't.
139
It is generally preferred to build the kernel with ``CONFIG_KALLSYMS`` so
140 141
that it produces readable dumps that can be used as-is (this also
produces better output than ksymoops).  If for some reason your kernel
142
is not build with ``CONFIG_KALLSYMS`` and you have no way to rebuild and
143 144
reproduce the Oops with that option, then you can still decode that Oops
with ksymoops.
Linus Torvalds's avatar
Linus Torvalds committed
145 146 147 148

Mkinitrd
--------

149
These changes to the ``/lib/modules`` file tree layout also require that
Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153 154
mkinitrd be upgraded.

E2fsprogs
---------

155
The latest version of ``e2fsprogs`` fixes several bugs in fsck and
Linus Torvalds's avatar
Linus Torvalds committed
156 157 158 159 160
debugfs.  Obviously, it's a good idea to upgrade.

JFSutils
--------

161
The ``jfsutils`` package contains the utilities for the file system.
Linus Torvalds's avatar
Linus Torvalds committed
162
The following utilities are available:
163 164

- ``fsck.jfs`` - initiate replay of the transaction log, and check
Linus Torvalds's avatar
Linus Torvalds committed
165
  and repair a JFS formatted partition.
166 167 168 169

- ``mkfs.jfs`` - create a JFS formatted partition.

- other file system utilities are also available in this package.
Linus Torvalds's avatar
Linus Torvalds committed
170 171 172 173 174 175

Reiserfsprogs
-------------

The reiserfsprogs package should be used for reiserfs-3.6.x
(Linux kernels 2.4.x). It is a combined package and contains working
176 177
versions of ``mkreiserfs``, ``resize_reiserfs``, ``debugreiserfs`` and
``reiserfsck``. These utils work on both i386 and alpha platforms.
Linus Torvalds's avatar
Linus Torvalds committed
178 179 180 181

Xfsprogs
--------

182 183
The latest version of ``xfsprogs`` contains ``mkfs.xfs``, ``xfs_db``, and the
``xfs_repair`` utilities, among others, for the XFS filesystem.  It is
Linus Torvalds's avatar
Linus Torvalds committed
184 185 186 187
architecture independent and any version from 2.0.0 onward should
work correctly with this version of the XFS kernel code (2.6.0 or
later is recommended, due to some significant improvements).

188 189 190
PCMCIAutils
-----------

191
PCMCIAutils replaces ``pcmcia-cs``. It properly sets up
192 193 194
PCMCIA sockets at system startup and loads the appropriate modules
for 16-bit PCMCIA devices if the kernel is modularized and the hotplug
subsystem is used.
Linus Torvalds's avatar
Linus Torvalds committed
195 196 197 198 199 200 201 202 203 204 205 206 207

Quota-tools
-----------

Support for 32 bit uid's and gid's is required if you want to use
the newer version 2 quota format.  Quota-tools version 3.07 and
newer has this support.  Use the recommended version or newer
from the table above.

Intel IA32 microcode
--------------------

A driver has been added to allow updating of Intel IA32 microcode,
208
accessible as a normal (misc) character device.  If you are not using
209
udev you may need to::
210 211 212 213

  mkdir /dev/cpu
  mknod /dev/cpu/microcode c 10 184
  chmod 0644 /dev/cpu/microcode
Linus Torvalds's avatar
Linus Torvalds committed
214 215 216 217 218 219

as root before you can use this.  You'll probably also want to
get the user-space microcode_ctl utility to use with this.

udev
----
220 221 222

``udev`` is a userspace application for populating ``/dev`` dynamically with
only entries for devices actually present. ``udev`` replaces the basic
223
functionality of devfs, while allowing persistent device naming for
224
devices.
Linus Torvalds's avatar
Linus Torvalds committed
225

226 227 228 229
FUSE
----

Needs libfuse 2.4.0 or later.  Absolute minimum is 2.3.0 but mount
230
options ``direct_io`` and ``kernel_cache`` won't work.
231

Linus Torvalds's avatar
Linus Torvalds committed
232
Networking
233
**********
Linus Torvalds's avatar
Linus Torvalds committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

General changes
---------------

If you have advanced network configuration needs, you should probably
consider using the network tools from ip-route2.

Packet Filter / NAT
-------------------
The packet filtering and NAT code uses the same tools like the previous 2.4.x
kernel series (iptables).  It still includes backwards-compatibility modules
for 2.2.x-style ipchains and 2.0.x-style ipfwadm.

PPP
---

The PPP driver has been restructured to support multilink and to
enable it to operate over diverse media layers.  If you use PPP,
upgrade pppd to at least 2.4.0.

254
If you are not using udev, you must have the device file /dev/ppp
255
which can be made by::
256 257

  mknod /dev/ppp c 108 0
Linus Torvalds's avatar
Linus Torvalds committed
258 259 260 261 262 263 264 265 266 267 268 269

as root.

Isdn4k-utils
------------

Due to changes in the length of the phone number field, isdn4k-utils
needs to be recompiled or (preferably) upgraded.

NFS-utils
---------

270 271
In ancient (2.4 and earlier) kernels, the nfs server needed to know
about any client that expected to be able to access files via NFS.  This
272 273 274
information would be given to the kernel by ``mountd`` when the client
mounted the filesystem, or by ``exportfs`` at system startup.  exportfs
would take information about active clients from ``/var/lib/nfs/rmtab``.
Linus Torvalds's avatar
Linus Torvalds committed
275 276 277

This approach is quite fragile as it depends on rmtab being correct
which is not always easy, particularly when trying to implement
278
fail-over.  Even when the system is working well, ``rmtab`` suffers from
Linus Torvalds's avatar
Linus Torvalds committed
279 280
getting lots of old entries that never get removed.

281 282 283
With modern kernels we have the option of having the kernel tell mountd
when it gets a request from an unknown host, and mountd can give
appropriate export information to the kernel.  This removes the
284
dependency on ``rmtab`` and means that the kernel only needs to know about
285
currently active clients.
Linus Torvalds's avatar
Linus Torvalds committed
286

287
To enable this new functionality, you need to::
288

289
  mount -t nfsd nfsd /proc/fs/nfsd
Linus Torvalds's avatar
Linus Torvalds committed
290 291 292 293 294

before running exportfs or mountd.  It is recommended that all NFS
services be protected from the internet-at-large by a firewall where
that is possible.

295 296 297
mcelog
------

298
On x86 kernels the mcelog utility is needed to process and log machine check
299 300
events when ``CONFIG_X86_MCE`` is enabled. Machine check events are errors
reported by the CPU. Processing them is strongly encouraged.
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
Kernel documentation
********************

Sphinx
------

The ReST markups currently used by the Documentation/ files are meant to be
built with ``Sphinx`` version 1.2 or upper. If you're desiring to build
PDF outputs, it is recommended to use version 1.4.6.

.. note::

  Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
  version 3.14159265. Depending on the distribution, you may also need
  to install a series of ``texlive`` packages that provide the minimal
  set of functionalities required for ``XeLaTex`` to work.

Other tools
-----------

In order to produce documentation from DocBook, you'll also need ``xmlto``.
Please notice, however, that we're currently migrating all documents to use
``Sphinx``.

Linus Torvalds's avatar
Linus Torvalds committed
326 327 328 329 330 331
Getting updated software
========================

Kernel compilation
******************

332 333
gcc
---
334 335

- <ftp://ftp.gnu.org/gnu/gcc/>
Linus Torvalds's avatar
Linus Torvalds committed
336 337 338

Make
----
339 340

- <ftp://ftp.gnu.org/gnu/make/>
Linus Torvalds's avatar
Linus Torvalds committed
341 342 343

Binutils
--------
344 345

- <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
Linus Torvalds's avatar
Linus Torvalds committed
346

347 348
OpenSSL
-------
349 350

- <https://www.openssl.org/>
351

Linus Torvalds's avatar
Linus Torvalds committed
352 353 354 355 356
System utilities
****************

Util-linux
----------
357 358

- <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
Linus Torvalds's avatar
Linus Torvalds committed
359

360 361 362 363 364 365
Kmod
----

- <https://www.kernel.org/pub/linux/utils/kernel/kmod/>
- <https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git>

Linus Torvalds's avatar
Linus Torvalds committed
366 367
Ksymoops
--------
368 369

- <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
Linus Torvalds's avatar
Linus Torvalds committed
370 371 372

Mkinitrd
--------
373 374

- <https://code.launchpad.net/initrd-tools/main>
Linus Torvalds's avatar
Linus Torvalds committed
375 376 377

E2fsprogs
---------
378 379

- <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
Linus Torvalds's avatar
Linus Torvalds committed
380 381 382

JFSutils
--------
383 384

- <http://jfs.sourceforge.net/>
Linus Torvalds's avatar
Linus Torvalds committed
385 386 387

Reiserfsprogs
-------------
388 389

- <http://www.kernel.org/pub/linux/utils/fs/reiserfs/>
Linus Torvalds's avatar
Linus Torvalds committed
390 391 392

Xfsprogs
--------
393 394

- <ftp://oss.sgi.com/projects/xfs/>
Linus Torvalds's avatar
Linus Torvalds committed
395

396 397
Pcmciautils
-----------
398 399

- <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
400

Linus Torvalds's avatar
Linus Torvalds committed
401
Quota-tools
402 403 404
-----------

- <http://sourceforge.net/projects/linuxquota/>
Linus Torvalds's avatar
Linus Torvalds committed
405 406 407

DocBook Stylesheets
-------------------
408 409

- <http://sourceforge.net/projects/docbook/files/docbook-dsssl/>
Linus Torvalds's avatar
Linus Torvalds committed
410

411 412
XMLTO XSLT Frontend
-------------------
413 414

- <http://cyberelk.net/tim/xmlto/>
415

Linus Torvalds's avatar
Linus Torvalds committed
416 417
Intel P6 microcode
------------------
418 419

- <https://downloadcenter.intel.com/>
Linus Torvalds's avatar
Linus Torvalds committed
420 421 422

udev
----
423 424

- <http://www.freedesktop.org/software/systemd/man/udev.html>
Linus Torvalds's avatar
Linus Torvalds committed
425

426 427
FUSE
----
428 429

- <http://sourceforge.net/projects/fuse>
430

431 432
mcelog
------
433 434

- <http://www.mcelog.org/>
435

Linus Torvalds's avatar
Linus Torvalds committed
436 437 438 439 440
Networking
**********

PPP
---
441 442

- <ftp://ftp.samba.org/pub/ppp/>
Linus Torvalds's avatar
Linus Torvalds committed
443 444 445

Isdn4k-utils
------------
446 447

- <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/>
Linus Torvalds's avatar
Linus Torvalds committed
448 449 450

NFS-utils
---------
451 452

- <http://sourceforge.net/project/showfiles.php?group_id=14>
Linus Torvalds's avatar
Linus Torvalds committed
453 454 455

Iptables
--------
456 457

- <http://www.iptables.org/downloads.html>
Linus Torvalds's avatar
Linus Torvalds committed
458 459 460

Ip-route2
---------
461 462

- <https://www.kernel.org/pub/linux/utils/net/iproute2/>
Linus Torvalds's avatar
Linus Torvalds committed
463 464 465

OProfile
--------
466 467

- <http://oprofile.sf.net/download/>
Linus Torvalds's avatar
Linus Torvalds committed
468 469 470

NFS-Utils
---------
471 472

- <http://nfs.sourceforge.net/>
473 474 475 476 477 478 479 480

Kernel documentation
********************

Sphinx
------

- <http://www.sphinx-doc.org/>