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