changes.rst 12.4 KB
Newer Older
1 2
.. _changes:

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

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
====================== ===============  ========================================
        Program        Minimal version       Command to check the version
====================== ===============  ========================================
GNU C                  3.2              gcc --version
33
GNU make               3.81             make --version
34
binutils               2.20             ld -v
35 36
flex                   2.5.35           flex --version
bison                  2.0              bison --version
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
util-linux             2.10o            fdformat --version
module-init-tools      0.9.10           depmod -V
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
58
Sphinx\ [#f1]_	       1.3		sphinx-build --version
59
====================== ===============  ========================================
60

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

Kernel compilation
64
******************
Linus Torvalds's avatar
Linus Torvalds committed
65 66 67 68 69

GCC
---

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

Make
----

75
You will need GNU make 3.81 or later to build the kernel.
Linus Torvalds's avatar
Linus Torvalds committed
76 77 78 79

Binutils
--------

80
The build system has, as of 4.13, switched to using thin archives (`ar T`)
81
rather than incremental linking (`ld -r`) for built-in.a intermediate steps.
82
This requires binutils 2.20 or newer.
Linus Torvalds's avatar
Linus Torvalds committed
83

84 85 86 87 88 89 90 91 92 93 94 95 96
Flex
----

Since Linux 4.16, the build system generates lexical analyzers
during build.  This requires flex 2.5.35 or later.


Bison
-----

Since Linux 4.16, the build system generates parsers
during build.  This requires bison 2.0 or later.

97 98 99
Perl
----

100 101
You will need perl 5 and the following modules: ``Getopt::Long``,
``Getopt::Std``, ``File::Basename``, and ``File::Find`` to build the kernel.
102

103 104 105 106 107
BC
--

You will need bc to build kernels 3.10 and higher

108

109 110 111 112 113 114 115 116 117 118 119
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
120
System utilities
121
****************
Linus Torvalds's avatar
Linus Torvalds committed
122 123 124 125 126 127 128 129 130 131 132

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
133 134 135 136 137
definitions in the source.  These comments can be combined with ReST
files the Documentation/ directory to make enriched documentation, which can
then be converted to PostScript, HTML, LaTex, ePUB and PDF files.
In order to convert from ReST format to a format of your choice, you'll need
Sphinx.
Linus Torvalds's avatar
Linus Torvalds committed
138 139 140 141

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

142
New versions of util-linux provide ``fdisk`` support for larger disks,
Linus Torvalds's avatar
Linus Torvalds committed
143 144 145 146 147 148 149
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
--------

150 151
If the unthinkable happens and your kernel oopses, you may need the
ksymoops tool to decode it, but in most cases you don't.
152
It is generally preferred to build the kernel with ``CONFIG_KALLSYMS`` so
153 154
that it produces readable dumps that can be used as-is (this also
produces better output than ksymoops).  If for some reason your kernel
155
is not build with ``CONFIG_KALLSYMS`` and you have no way to rebuild and
156 157
reproduce the Oops with that option, then you can still decode that Oops
with ksymoops.
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160 161

Module-Init-Tools
-----------------

162
A new module loader is now in the kernel that requires ``module-init-tools``
Linus Torvalds's avatar
Linus Torvalds committed
163 164 165 166 167
to use.  It is backward compatible with the 2.4.x series kernels.

Mkinitrd
--------

168
These changes to the ``/lib/modules`` file tree layout also require that
Linus Torvalds's avatar
Linus Torvalds committed
169 170 171 172 173
mkinitrd be upgraded.

E2fsprogs
---------

174
The latest version of ``e2fsprogs`` fixes several bugs in fsck and
Linus Torvalds's avatar
Linus Torvalds committed
175 176 177 178 179
debugfs.  Obviously, it's a good idea to upgrade.

JFSutils
--------

180
The ``jfsutils`` package contains the utilities for the file system.
Linus Torvalds's avatar
Linus Torvalds committed
181
The following utilities are available:
182 183

- ``fsck.jfs`` - initiate replay of the transaction log, and check
Linus Torvalds's avatar
Linus Torvalds committed
184
  and repair a JFS formatted partition.
185 186 187 188

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

- other file system utilities are also available in this package.
Linus Torvalds's avatar
Linus Torvalds committed
189 190 191 192 193 194

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
195 196
versions of ``mkreiserfs``, ``resize_reiserfs``, ``debugreiserfs`` and
``reiserfsck``. These utils work on both i386 and alpha platforms.
Linus Torvalds's avatar
Linus Torvalds committed
197 198 199 200

Xfsprogs
--------

201 202
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
203 204 205 206
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).

207 208 209
PCMCIAutils
-----------

210
PCMCIAutils replaces ``pcmcia-cs``. It properly sets up
211 212 213
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
214 215 216 217 218 219 220 221 222 223 224 225 226

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,
227
accessible as a normal (misc) character device.  If you are not using
Jonathan Corbet's avatar
Jonathan Corbet committed
228
udev you may need to::
229 230 231 232

  mkdir /dev/cpu
  mknod /dev/cpu/microcode c 10 184
  chmod 0644 /dev/cpu/microcode
Linus Torvalds's avatar
Linus Torvalds committed
233 234 235 236 237 238

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
----
239 240 241

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

245 246 247 248
FUSE
----

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

Linus Torvalds's avatar
Linus Torvalds committed
251
Networking
252
**********
Linus Torvalds's avatar
Linus Torvalds committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

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.

273
If you are not using udev, you must have the device file /dev/ppp
Jonathan Corbet's avatar
Jonathan Corbet committed
274
which can be made by::
275 276

  mknod /dev/ppp c 108 0
Linus Torvalds's avatar
Linus Torvalds committed
277 278 279 280 281 282 283 284 285 286 287 288

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
---------

289 290
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
291 292 293
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
294 295 296

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

300 301 302
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
303
dependency on ``rmtab`` and means that the kernel only needs to know about
304
currently active clients.
Linus Torvalds's avatar
Linus Torvalds committed
305

Jonathan Corbet's avatar
Jonathan Corbet committed
306
To enable this new functionality, you need to::
307

308
  mount -t nfsd nfsd /proc/fs/nfsd
Linus Torvalds's avatar
Linus Torvalds committed
309 310 311 312 313

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.

314 315 316
mcelog
------

317
On x86 kernels the mcelog utility is needed to process and log machine check
318 319
events when ``CONFIG_X86_MCE`` is enabled. Machine check events are errors
reported by the CPU. Processing them is strongly encouraged.
320

321 322 323 324 325 326
Kernel documentation
********************

Sphinx
------

327 328
Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst``
for details about Sphinx requirements.
329

Linus Torvalds's avatar
Linus Torvalds committed
330 331 332 333 334 335
Getting updated software
========================

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

Andrew Morton's avatar
Andrew Morton committed
336 337
gcc
---
338 339

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

Make
----
343 344

- <ftp://ftp.gnu.org/gnu/make/>
Linus Torvalds's avatar
Linus Torvalds committed
345 346 347

Binutils
--------
348

349
- <https://www.kernel.org/pub/linux/devel/binutils/>
Linus Torvalds's avatar
Linus Torvalds committed
350

351 352 353 354 355 356 357 358 359 360
Flex
----

- <https://github.com/westes/flex/releases>

Bison
-----

- <ftp://ftp.gnu.org/gnu/bison/>

361 362
OpenSSL
-------
363 364

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

Linus Torvalds's avatar
Linus Torvalds committed
366 367 368 369 370
System utilities
****************

Util-linux
----------
371

372
- <https://www.kernel.org/pub/linux/utils/util-linux/>
Linus Torvalds's avatar
Linus Torvalds committed
373 374 375

Ksymoops
--------
376

377
- <https://www.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
Linus Torvalds's avatar
Linus Torvalds committed
378 379 380

Module-Init-Tools
-----------------
381

382
- <https://www.kernel.org/pub/linux/utils/kernel/module-init-tools/>
Linus Torvalds's avatar
Linus Torvalds committed
383 384 385

Mkinitrd
--------
386 387

- <https://code.launchpad.net/initrd-tools/main>
Linus Torvalds's avatar
Linus Torvalds committed
388 389 390

E2fsprogs
---------
391 392

- <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
Linus Torvalds's avatar
Linus Torvalds committed
393 394 395

JFSutils
--------
396 397

- <http://jfs.sourceforge.net/>
Linus Torvalds's avatar
Linus Torvalds committed
398 399 400

Reiserfsprogs
-------------
401 402

- <http://www.kernel.org/pub/linux/utils/fs/reiserfs/>
Linus Torvalds's avatar
Linus Torvalds committed
403 404 405

Xfsprogs
--------
406 407

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

409 410
Pcmciautils
-----------
411

412
- <https://www.kernel.org/pub/linux/utils/kernel/pcmcia/>
413

Linus Torvalds's avatar
Linus Torvalds committed
414
Quota-tools
415 416 417
-----------

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

419

Linus Torvalds's avatar
Linus Torvalds committed
420 421
Intel P6 microcode
------------------
422 423

- <https://downloadcenter.intel.com/>
Linus Torvalds's avatar
Linus Torvalds committed
424 425 426

udev
----
427 428

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

430 431
FUSE
----
432 433

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

435 436
mcelog
------
437 438

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

Linus Torvalds's avatar
Linus Torvalds committed
440 441 442 443 444
Networking
**********

PPP
---
445 446

- <ftp://ftp.samba.org/pub/ppp/>
Linus Torvalds's avatar
Linus Torvalds committed
447 448 449

Isdn4k-utils
------------
450 451

- <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/>
Linus Torvalds's avatar
Linus Torvalds committed
452 453 454

NFS-utils
---------
455 456

- <http://sourceforge.net/project/showfiles.php?group_id=14>
Linus Torvalds's avatar
Linus Torvalds committed
457 458 459

Iptables
--------
460 461

- <http://www.iptables.org/downloads.html>
Linus Torvalds's avatar
Linus Torvalds committed
462 463 464

Ip-route2
---------
465 466

- <https://www.kernel.org/pub/linux/utils/net/iproute2/>
Linus Torvalds's avatar
Linus Torvalds committed
467 468 469

OProfile
--------
470 471

- <http://oprofile.sf.net/download/>
Linus Torvalds's avatar
Linus Torvalds committed
472 473 474

NFS-Utils
---------
475 476

- <http://nfs.sourceforge.net/>
477 478 479 480 481 482 483 484

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

Sphinx
------

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