Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/sam/kbuild...
[sfrench/cifs-2.6.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 System utilities
76 ================
77
78 Architectural changes
79 ---------------------
80
81 DevFS has been obsoleted in favour of udev
82 (http://www.kernel.org/pub/linux/utils/kernel/hotplug/)
83
84 32-bit UID support is now in place.  Have fun!
85
86 Linux documentation for functions is transitioning to inline
87 documentation via specially-formatted comments near their
88 definitions in the source.  These comments can be combined with the
89 SGML templates in the Documentation/DocBook directory to make DocBook
90 files, which can then be converted by DocBook stylesheets to PostScript,
91 HTML, PDF files, and several other formats.  In order to convert from
92 DocBook format to a format of your choice, you'll need to install Jade as
93 well as the desired DocBook stylesheets.
94
95 Util-linux
96 ----------
97
98 New versions of util-linux provide *fdisk support for larger disks,
99 support new options to mount, recognize more supported partition
100 types, have a fdformat which works with 2.4 kernels, and similar goodies.
101 You'll probably want to upgrade.
102
103 Ksymoops
104 --------
105
106 If the unthinkable happens and your kernel oopses, you may need the
107 ksymoops tool to decode it, but in most cases you don't.
108 In the 2.6 kernel it is generally preferred to build the kernel with
109 CONFIG_KALLSYMS so that it produces readable dumps that can be used as-is
110 (this also produces better output than ksymoops).
111 If for some reason your kernel is not build with CONFIG_KALLSYMS and
112 you have no way to rebuild and reproduce the Oops with that option, then
113 you can still decode that Oops with ksymoops.
114
115 Module-Init-Tools
116 -----------------
117
118 A new module loader is now in the kernel that requires module-init-tools
119 to use.  It is backward compatible with the 2.4.x series kernels.
120
121 Mkinitrd
122 --------
123
124 These changes to the /lib/modules file tree layout also require that
125 mkinitrd be upgraded.
126
127 E2fsprogs
128 ---------
129
130 The latest version of e2fsprogs fixes several bugs in fsck and
131 debugfs.  Obviously, it's a good idea to upgrade.
132
133 JFSutils
134 --------
135
136 The jfsutils package contains the utilities for the file system.
137 The following utilities are available:
138 o fsck.jfs - initiate replay of the transaction log, and check
139   and repair a JFS formatted partition.
140 o mkfs.jfs - create a JFS formatted partition.
141 o other file system utilities are also available in this package.
142
143 Reiserfsprogs
144 -------------
145
146 The reiserfsprogs package should be used for reiserfs-3.6.x
147 (Linux kernels 2.4.x). It is a combined package and contains working
148 versions of mkreiserfs, resize_reiserfs, debugreiserfs and
149 reiserfsck. These utils work on both i386 and alpha platforms.
150
151 Xfsprogs
152 --------
153
154 The latest version of xfsprogs contains mkfs.xfs, xfs_db, and the
155 xfs_repair utilities, among others, for the XFS filesystem.  It is
156 architecture independent and any version from 2.0.0 onward should
157 work correctly with this version of the XFS kernel code (2.6.0 or
158 later is recommended, due to some significant improvements).
159
160 PCMCIAutils
161 -----------
162
163 PCMCIAutils replaces pcmcia-cs (see below). It properly sets up
164 PCMCIA sockets at system startup and loads the appropriate modules
165 for 16-bit PCMCIA devices if the kernel is modularized and the hotplug
166 subsystem is used.
167
168 Pcmcia-cs
169 ---------
170
171 PCMCIA (PC Card) support is now partially implemented in the main
172 kernel source. The "pcmciautils" package (see above) replaces pcmcia-cs
173 for newest kernels.
174
175 Quota-tools
176 -----------
177
178 Support for 32 bit uid's and gid's is required if you want to use
179 the newer version 2 quota format.  Quota-tools version 3.07 and
180 newer has this support.  Use the recommended version or newer
181 from the table above.
182
183 Intel IA32 microcode
184 --------------------
185
186 A driver has been added to allow updating of Intel IA32 microcode,
187 accessible as a normal (misc) character device.  If you are not using
188 udev you may need to:
189
190 mkdir /dev/cpu
191 mknod /dev/cpu/microcode c 10 184
192 chmod 0644 /dev/cpu/microcode
193
194 as root before you can use this.  You'll probably also want to
195 get the user-space microcode_ctl utility to use with this.
196
197 Powertweak
198 ----------
199
200 If you are running v0.1.17 or earlier, you should upgrade to
201 version v0.99.0 or higher. Running old versions may cause problems
202 with programs using shared memory.
203
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.
210
211 FUSE
212 ----
213
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.
216
217 Networking
218 ==========
219
220 General changes
221 ---------------
222
223 If you have advanced network configuration needs, you should probably
224 consider using the network tools from ip-route2.
225
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.
231
232 PPP
233 ---
234
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.
238
239 If you are not using udev, you must have the device file /dev/ppp
240 which can be made by:
241
242 mknod /dev/ppp c 108 0
243
244 as root.
245
246 Isdn4k-utils
247 ------------
248
249 Due to changes in the length of the phone number field, isdn4k-utils
250 needs to be recompiled or (preferably) upgraded.
251
252 NFS-utils
253 ---------
254
255 In 2.4 and earlier kernels, the nfs server needed to know about any
256 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.
260
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.
265
266 With 2.6 we have the option of having the kernel tell mountd when it
267 gets a request from an unknown host, and mountd can give appropriate
268 export information to the kernel.  This removes the dependency on
269 rmtab and means that the kernel only needs to know about currently
270 active clients.
271
272 To enable this new functionality, you need to:
273
274   mount -t nfsd nfsd /proc/fs/nfsd
275
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.
279
280 mcelog
281 ------
282
283 In Linux 2.6.31+ the i386 kernel needs to run the mcelog utility
284 as a regular cronjob similar to the x86-64 kernel to process and log
285 machine check events when CONFIG_X86_NEW_MCE is enabled. Machine check
286 events are errors reported by the CPU. Processing them is strongly encouraged.
287 All x86-64 kernels since 2.6.4 require the mcelog utility to
288 process machine checks.
289
290 Getting updated software
291 ========================
292
293 Kernel compilation
294 ******************
295
296 gcc
297 ---
298 o  <ftp://ftp.gnu.org/gnu/gcc/>
299
300 Make
301 ----
302 o  <ftp://ftp.gnu.org/gnu/make/>
303
304 Binutils
305 --------
306 o  <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
307
308 System utilities
309 ****************
310
311 Util-linux
312 ----------
313 o  <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
314
315 Ksymoops
316 --------
317 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
318
319 Module-Init-Tools
320 -----------------
321 o  <ftp://ftp.kernel.org/pub/linux/kernel/people/rusty/modules/>
322
323 Mkinitrd
324 --------
325 o  <ftp://rawhide.redhat.com/pub/rawhide/SRPMS/SRPMS/>
326
327 E2fsprogs
328 ---------
329 o  <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
330
331 JFSutils
332 --------
333 o  <http://jfs.sourceforge.net/>
334
335 Reiserfsprogs
336 -------------
337 o  <http://www.namesys.com/pub/reiserfsprogs/reiserfsprogs-3.6.3.tar.gz>
338
339 Xfsprogs
340 --------
341 o  <ftp://oss.sgi.com/projects/xfs/download/>
342
343 Pcmciautils
344 -----------
345 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
346
347 Pcmcia-cs
348 ---------
349 o  <http://pcmcia-cs.sourceforge.net/>
350
351 Quota-tools
352 ----------
353 o  <http://sourceforge.net/projects/linuxquota/>
354
355 DocBook Stylesheets
356 -------------------
357 o  <http://nwalsh.com/docbook/dsssl/>
358
359 XMLTO XSLT Frontend
360 -------------------
361 o  <http://cyberelk.net/tim/xmlto/>
362
363 Intel P6 microcode
364 ------------------
365 o  <http://www.urbanmyth.org/microcode/>
366
367 Powertweak
368 ----------
369 o  <http://powertweak.sourceforge.net/>
370
371 udev
372 ----
373 o <http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html>
374
375 FUSE
376 ----
377 o <http://sourceforge.net/projects/fuse>
378
379 mcelog
380 ------
381 o <ftp://ftp.kernel.org/pub/linux/utils/cpu/mce/mcelog/>
382
383 Networking
384 **********
385
386 PPP
387 ---
388 o  <ftp://ftp.samba.org/pub/ppp/ppp-2.4.0.tar.gz>
389
390 Isdn4k-utils
391 ------------
392 o  <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/isdn4k-utils.v3.1pre1.tar.gz>
393
394 NFS-utils
395 ---------
396 o  <http://sourceforge.net/project/showfiles.php?group_id=14>
397
398 Iptables
399 --------
400 o  <http://www.iptables.org/downloads.html>
401
402 Ip-route2
403 ---------
404 o  <ftp://ftp.tux.org/pub/net/ip-routing/iproute2-2.2.4-now-ss991023.tar.gz>
405
406 OProfile
407 --------
408 o  <http://oprofile.sf.net/download/>
409
410 NFS-Utils
411 ---------
412 o  <http://nfs.sourceforge.net/>
413