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