Documentation/Changes

   1 Minimal requerements to compile the Kernel
   2 ++++++++++++++++++++++++++++++++++++++++++
   3
   4 Intro
   5 =====
   6
   7 This document is designed to provide a list of the minimum levels of
   8 software necessary to run the 3.0 kernels.
   9
  10 This document is originally based on my "Changes" file for 2.0.x kernels
  11 and therefore owes credit to the same people as that file (Jared Mauch,
  12 Axel Boldt, Alessandro Sigala, and countless other users all over the
  13 'net).
  14
  15 Current Minimal Requirements
  16 ****************************
  17
  18 Upgrade to at **least** these software revisions before thinking you've
  19 encountered a bug!  If you're unsure what version you're currently
  20 running, the suggested command should tell you.
  21
  22 Again, keep in mind that this list assumes you are already functionally
  23 running a Linux kernel.  Also, not all tools are necessary on all
  24 systems; obviously, if you don't have any ISDN hardware, for example,
  25 you probably needn't concern yourself with isdn4k-utils.
  26
  27 ====================== ===============  ========================================
  28         Program        Minimal version       Command to check the version
  29 ====================== ===============  ========================================
  30 GNU C                  3.2              gcc --version
  31 GNU make               3.80             make --version
  32 binutils               2.12             ld -v
  33 util-linux             2.10o            fdformat --version
  34 module-init-tools      0.9.10           depmod -V
  35 e2fsprogs              1.41.4           e2fsck -V
  36 jfsutils               1.1.3            fsck.jfs -V
  37 reiserfsprogs          3.6.3            reiserfsck -V
  38 xfsprogs               2.6.0            xfs_db -V
  39 squashfs-tools         4.0              mksquashfs -version
  40 btrfs-progs            0.18             btrfsck
  41 pcmciautils            004              pccardctl -V
  42 quota-tools            3.09             quota -V
  43 PPP                    2.4.0            pppd --version
  44 isdn4k-utils           3.1pre1          isdnctrl 2>&1|grep version
  45 nfs-utils              1.0.5            showmount --version
  46 procps                 3.2.0            ps --version
  47 oprofile               0.9              oprofiled --version
  48 udev                   081              udevd --version
  49 grub                   0.93             grub --version || grub-install --version
  50 mcelog                 0.6              mcelog --version
  51 iptables               1.4.2            iptables -V
  52 openssl & libcrypto    1.0.0            openssl version
  53 bc                     1.06.95          bc --version
  54 ====================== ===============  ========================================
  55
  56
  57 Kernel compilation
  58 ******************
  59
  60 GCC
  61 ---
  62
  63 The gcc version requirements may vary depending on the type of CPU in your
  64 computer.
  65
  66 Make
  67 ----
  68
  69 You will need GNU make 3.80 or later to build the kernel.
  70
  71 Binutils
  72 --------
  73
  74 Linux on IA-32 has recently switched from using ``as86`` to using ``gas`` for
  75 assembling the 16-bit boot code, removing the need for ``as86`` to compile
  76 your kernel.  This change does, however, mean that you need a recent
  77 release of binutils.
  78
  79 Perl
  80 ----
  81
  82 You will need perl 5 and the following modules: ``Getopt::Long``,
  83 ``Getopt::Std``, ``File::Basename``, and ``File::Find`` to build the kernel.
  84
  85 BC
  86 --
  87
  88 You will need bc to build kernels 3.10 and higher
  89
  90
  91 OpenSSL
  92 -------
  93
  94 Module signing and external certificate handling use the OpenSSL program and
  95 crypto library to do key creation and signature generation.
  96
  97 You will need openssl to build kernels 3.7 and higher if module signing is
  98 enabled.  You will also need openssl development packages to build kernels 4.3
  99 and higher.
 100
 101
 102 System utilities
 103 ****************
 104
 105 Architectural changes
 106 ---------------------
 107
 108 DevFS has been obsoleted in favour of udev
 109 (http://www.kernel.org/pub/linux/utils/kernel/hotplug/)
 110
 111 32-bit UID support is now in place.  Have fun!
 112
 113 Linux documentation for functions is transitioning to inline
 114 documentation via specially-formatted comments near their
 115 definitions in the source.  These comments can be combined with the
 116 SGML templates in the Documentation/DocBook directory to make DocBook
 117 files, which can then be converted by DocBook stylesheets to PostScript,
 118 HTML, PDF files, and several other formats.  In order to convert from
 119 DocBook format to a format of your choice, you'll need to install Jade as
 120 well as the desired DocBook stylesheets.
 121
 122 Util-linux
 123 ----------
 124
 125 New versions of util-linux provide ``fdisk`` support for larger disks,
 126 support new options to mount, recognize more supported partition
 127 types, have a fdformat which works with 2.4 kernels, and similar goodies.
 128 You'll probably want to upgrade.
 129
 130 Ksymoops
 131 --------
 132
 133 If the unthinkable happens and your kernel oopses, you may need the
 134 ksymoops tool to decode it, but in most cases you don't.
 135 It is generally preferred to build the kernel with ``CONFIG_KALLSYMS`` so
 136 that it produces readable dumps that can be used as-is (this also
 137 produces better output than ksymoops).  If for some reason your kernel
 138 is not build with ``CONFIG_KALLSYMS`` and you have no way to rebuild and
 139 reproduce the Oops with that option, then you can still decode that Oops
 140 with ksymoops.
 141
 142 Module-Init-Tools
 143 -----------------
 144
 145 A new module loader is now in the kernel that requires ``module-init-tools``
 146 to use.  It is backward compatible with the 2.4.x series kernels.
 147
 148 Mkinitrd
 149 --------
 150
 151 These changes to the ``/lib/modules`` file tree layout also require that
 152 mkinitrd be upgraded.
 153
 154 E2fsprogs
 155 ---------
 156
 157 The latest version of ``e2fsprogs`` fixes several bugs in fsck and
 158 debugfs.  Obviously, it's a good idea to upgrade.
 159
 160 JFSutils
 161 --------
 162
 163 The ``jfsutils`` package contains the utilities for the file system.
 164 The following utilities are available:
 165
 166 - ``fsck.jfs`` - initiate replay of the transaction log, and check
 167   and repair a JFS formatted partition.
 168
 169 - ``mkfs.jfs`` - create a JFS formatted partition.
 170
 171 - other file system utilities are also available in this package.
 172
 173 Reiserfsprogs
 174 -------------
 175
 176 The reiserfsprogs package should be used for reiserfs-3.6.x
 177 (Linux kernels 2.4.x). It is a combined package and contains working
 178 versions of ``mkreiserfs``, ``resize_reiserfs``, ``debugreiserfs`` and
 179 ``reiserfsck``. These utils work on both i386 and alpha platforms.
 180
 181 Xfsprogs
 182 --------
 183
 184 The latest version of ``xfsprogs`` contains ``mkfs.xfs``, ``xfs_db``, and the
 185 ``xfs_repair`` utilities, among others, for the XFS filesystem.  It is
 186 architecture independent and any version from 2.0.0 onward should
 187 work correctly with this version of the XFS kernel code (2.6.0 or
 188 later is recommended, due to some significant improvements).
 189
 190 PCMCIAutils
 191 -----------
 192
 193 PCMCIAutils replaces ``pcmcia-cs``. It properly sets up
 194 PCMCIA sockets at system startup and loads the appropriate modules
 195 for 16-bit PCMCIA devices if the kernel is modularized and the hotplug
 196 subsystem is used.
 197
 198 Quota-tools
 199 -----------
 200
 201 Support for 32 bit uid's and gid's is required if you want to use
 202 the newer version 2 quota format.  Quota-tools version 3.07 and
 203 newer has this support.  Use the recommended version or newer
 204 from the table above.
 205
 206 Intel IA32 microcode
 207 --------------------
 208
 209 A driver has been added to allow updating of Intel IA32 microcode,
 210 accessible as a normal (misc) character device.  If you are not using
 211 udev you may need to:
 212
 213 ::
 214
 215   mkdir /dev/cpu
 216   mknod /dev/cpu/microcode c 10 184
 217   chmod 0644 /dev/cpu/microcode
 218
 219 as root before you can use this.  You'll probably also want to
 220 get the user-space microcode_ctl utility to use with this.
 221
 222 udev
 223 ----
 224
 225 ``udev`` is a userspace application for populating ``/dev`` dynamically with
 226 only entries for devices actually present. ``udev`` replaces the basic
 227 functionality of devfs, while allowing persistent device naming for
 228 devices.
 229
 230 FUSE
 231 ----
 232
 233 Needs libfuse 2.4.0 or later.  Absolute minimum is 2.3.0 but mount
 234 options ``direct_io`` and ``kernel_cache`` won't work.
 235
 236 Networking
 237 **********
 238
 239 General changes
 240 ---------------
 241
 242 If you have advanced network configuration needs, you should probably
 243 consider using the network tools from ip-route2.
 244
 245 Packet Filter / NAT
 246 -------------------
 247 The packet filtering and NAT code uses the same tools like the previous 2.4.x
 248 kernel series (iptables).  It still includes backwards-compatibility modules
 249 for 2.2.x-style ipchains and 2.0.x-style ipfwadm.
 250
 251 PPP
 252 ---
 253
 254 The PPP driver has been restructured to support multilink and to
 255 enable it to operate over diverse media layers.  If you use PPP,
 256 upgrade pppd to at least 2.4.0.
 257
 258 If you are not using udev, you must have the device file /dev/ppp
 259 which can be made by:
 260
 261 ::
 262
 263   mknod /dev/ppp c 108 0
 264
 265 as root.
 266
 267 Isdn4k-utils
 268 ------------
 269
 270 Due to changes in the length of the phone number field, isdn4k-utils
 271 needs to be recompiled or (preferably) upgraded.
 272
 273 NFS-utils
 274 ---------
 275
 276 In ancient (2.4 and earlier) kernels, the nfs server needed to know
 277 about any client that expected to be able to access files via NFS.  This
 278 information would be given to the kernel by ``mountd`` when the client
 279 mounted the filesystem, or by ``exportfs`` at system startup.  exportfs
 280 would take information about active clients from ``/var/lib/nfs/rmtab``.
 281
 282 This approach is quite fragile as it depends on rmtab being correct
 283 which is not always easy, particularly when trying to implement
 284 fail-over.  Even when the system is working well, ``rmtab`` suffers from
 285 getting lots of old entries that never get removed.
 286
 287 With modern kernels we have the option of having the kernel tell mountd
 288 when it gets a request from an unknown host, and mountd can give
 289 appropriate export information to the kernel.  This removes the
 290 dependency on ``rmtab`` and means that the kernel only needs to know about
 291 currently active clients.
 292
 293 To enable this new functionality, you need to:
 294
 295 ::
 296
 297   mount -t nfsd nfsd /proc/fs/nfsd
 298
 299 before running exportfs or mountd.  It is recommended that all NFS
 300 services be protected from the internet-at-large by a firewall where
 301 that is possible.
 302
 303 mcelog
 304 ------
 305
 306 On x86 kernels the mcelog utility is needed to process and log machine check
 307 events when ``CONFIG_X86_MCE`` is enabled. Machine check events are errors
 308 reported by the CPU. Processing them is strongly encouraged.
 309
 310 Getting updated software
 311 ========================
 312
 313 Kernel compilation
 314 ******************
 315
 316 gcc
 317 ---
 318
 319 - <ftp://ftp.gnu.org/gnu/gcc/>
 320
 321 Make
 322 ----
 323
 324 - <ftp://ftp.gnu.org/gnu/make/>
 325
 326 Binutils
 327 --------
 328
 329 - <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
 330
 331 OpenSSL
 332 -------
 333
 334 - <https://www.openssl.org/>
 335
 336 System utilities
 337 ****************
 338
 339 Util-linux
 340 ----------
 341
 342 - <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
 343
 344 Ksymoops
 345 --------
 346
 347 - <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
 348
 349 Module-Init-Tools
 350 -----------------
 351
 352 - <ftp://ftp.kernel.org/pub/linux/kernel/people/rusty/modules/>
 353
 354 Mkinitrd
 355 --------
 356
 357 - <https://code.launchpad.net/initrd-tools/main>
 358
 359 E2fsprogs
 360 ---------
 361
 362 - <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
 363
 364 JFSutils
 365 --------
 366
 367 - <http://jfs.sourceforge.net/>
 368
 369 Reiserfsprogs
 370 -------------
 371
 372 - <http://www.kernel.org/pub/linux/utils/fs/reiserfs/>
 373
 374 Xfsprogs
 375 --------
 376
 377 - <ftp://oss.sgi.com/projects/xfs/>
 378
 379 Pcmciautils
 380 -----------
 381
 382 - <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
 383
 384 Quota-tools
 385 -----------
 386
 387 - <http://sourceforge.net/projects/linuxquota/>
 388
 389 DocBook Stylesheets
 390 -------------------
 391
 392 - <http://sourceforge.net/projects/docbook/files/docbook-dsssl/>
 393
 394 XMLTO XSLT Frontend
 395 -------------------
 396
 397 - <http://cyberelk.net/tim/xmlto/>
 398
 399 Intel P6 microcode
 400 ------------------
 401
 402 - <https://downloadcenter.intel.com/>
 403
 404 udev
 405 ----
 406
 407 - <http://www.freedesktop.org/software/systemd/man/udev.html>
 408
 409 FUSE
 410 ----
 411
 412 - <http://sourceforge.net/projects/fuse>
 413
 414 mcelog
 415 ------
 416
 417 - <http://www.mcelog.org/>
 418
 419 Networking
 420 **********
 421
 422 PPP
 423 ---
 424
 425 - <ftp://ftp.samba.org/pub/ppp/>
 426
 427 Isdn4k-utils
 428 ------------
 429
 430 - <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/>
 431
 432 NFS-utils
 433 ---------
 434
 435 - <http://sourceforge.net/project/showfiles.php?group_id=14>
 436
 437 Iptables
 438 --------
 439
 440 - <http://www.iptables.org/downloads.html>
 441
 442 Ip-route2
 443 ---------
 444
 445 - <https://www.kernel.org/pub/linux/utils/net/iproute2/>
 446
 447 OProfile
 448 --------
 449
 450 - <http://oprofile.sf.net/download/>
 451
 452 NFS-Utils
 453 ---------
 454
 455 - <http://nfs.sourceforge.net/>