[PATCH] message: fix-up schedule_timeout() usage
[linux-2.6] / 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 The latest revision of this document, in various formats, can always
19 be found at <http://cyberbuzz.gatech.edu/kaboom/linux/Changes-2.4/>.
20
21 Feel free to translate this document.  If you do so, please send me a
22 URL to your translation for inclusion in future revisions of this
23 document.
24
25 Smotrite file <http://oblom.rnc.ru/linux/kernel/Changes.ru>, yavlyaushisya
26 russkim perevodom dannogo documenta.
27
28 Visite <http://www2.adi.uam.es/~ender/tecnico/> para obtener la traducción
29 al español de este documento en varios formatos.
30
31 Eine deutsche Version dieser Datei finden Sie unter
32 <http://www.stefan-winter.de/Changes-2.4.0.txt>.
33
34 Last updated: October 29th, 2002
35
36 Chris Ricker (kaboom@gatech.edu or chris.ricker@genetics.utah.edu).
37
38 Current Minimal Requirements
39 ============================
40
41 Upgrade to at *least* these software revisions before thinking you've
42 encountered a bug!  If you're unsure what version you're currently
43 running, the suggested command should tell you.
44
45 Again, keep in mind that this list assumes you are already
46 functionally running a Linux 2.4 kernel.  Also, not all tools are
47 necessary on all systems; obviously, if you don't have any ISDN
48 hardware, for example, you probably needn't concern yourself with
49 isdn4k-utils.
50
51 o  Gnu C                  2.95.3                  # gcc --version
52 o  Gnu make               3.79.1                  # make --version
53 o  binutils               2.12                    # ld -v
54 o  util-linux             2.10o                   # fdformat --version
55 o  module-init-tools      0.9.10                  # depmod -V
56 o  e2fsprogs              1.29                    # tune2fs
57 o  jfsutils               1.1.3                   # fsck.jfs -V
58 o  reiserfsprogs          3.6.3                   # reiserfsck -V 2>&1|grep reiserfsprogs
59 o  xfsprogs               2.6.0                   # xfs_db -V
60 o  pcmciautils            004
61 o  pcmcia-cs              3.1.21                  # cardmgr -V
62 o  quota-tools            3.09                    # quota -V
63 o  PPP                    2.4.0                   # pppd --version
64 o  isdn4k-utils           3.1pre1                 # isdnctrl 2>&1|grep version
65 o  nfs-utils              1.0.5                   # showmount --version
66 o  procps                 3.2.0                   # ps --version
67 o  oprofile               0.9                     # oprofiled --version
68 o  udev                   071                     # udevinfo -V
69
70 Kernel compilation
71 ==================
72
73 GCC
74 ---
75
76 The gcc version requirements may vary depending on the type of CPU in your
77 computer. The next paragraph applies to users of x86 CPUs, but not
78 necessarily to users of other CPUs. Users of other CPUs should obtain
79 information about their gcc version requirements from another source.
80
81 The recommended compiler for the kernel is gcc 2.95.x (x >= 3), and it
82 should be used when you need absolute stability. You may use gcc 3.0.x
83 instead if you wish, although it may cause problems. Later versions of gcc 
84 have not received much testing for Linux kernel compilation, and there are 
85 almost certainly bugs (mainly, but not exclusively, in the kernel) that
86 will need to be fixed in order to use these compilers. In any case, using
87 pgcc instead of plain gcc is just asking for trouble.
88
89 The Red Hat gcc 2.96 compiler subtree can also be used to build this tree.
90 You should ensure you use gcc-2.96-74 or later. gcc-2.96-54 will not build
91 the kernel correctly.
92
93 In addition, please pay attention to compiler optimization.  Anything
94 greater than -O2 may not be wise.  Similarly, if you choose to use gcc-2.95.x
95 or derivatives, be sure not to use -fstrict-aliasing (which, depending on
96 your version of gcc 2.95.x, may necessitate using -fno-strict-aliasing).
97
98 Make
99 ----
100
101 You will need Gnu make 3.79.1 or later to build the kernel.
102
103 Binutils
104 --------
105
106 Linux on IA-32 has recently switched from using as86 to using gas for
107 assembling the 16-bit boot code, removing the need for as86 to compile
108 your kernel.  This change does, however, mean that you need a recent
109 release of binutils.
110
111 System utilities
112 ================
113
114 Architectural changes
115 ---------------------
116
117 DevFS has been obsoleted in favour of udev
118 (http://www.kernel.org/pub/linux/utils/kernel/hotplug/)
119
120 32-bit UID support is now in place.  Have fun!
121
122 Linux documentation for functions is transitioning to inline
123 documentation via specially-formatted comments near their
124 definitions in the source.  These comments can be combined with the
125 SGML templates in the Documentation/DocBook directory to make DocBook
126 files, which can then be converted by DocBook stylesheets to PostScript,
127 HTML, PDF files, and several other formats.  In order to convert from
128 DocBook format to a format of your choice, you'll need to install Jade as
129 well as the desired DocBook stylesheets.
130
131 Util-linux
132 ----------
133
134 New versions of util-linux provide *fdisk support for larger disks,
135 support new options to mount, recognize more supported partition
136 types, have a fdformat which works with 2.4 kernels, and similar goodies.
137 You'll probably want to upgrade.
138
139 Ksymoops
140 --------
141
142 If the unthinkable happens and your kernel oopses, you may need the
143 ksymoops tool to decode it, but in most cases you don't.
144 In the 2.6 kernel it is generally preferred to build the kernel with
145 CONFIG_KALLSYMS so that it produces readable dumps that can be used as-is
146 (this also produces better output than ksymoops).
147 If for some reason your kernel is not build with CONFIG_KALLSYMS and
148 you have no way to rebuild and reproduce the Oops with that option, then
149 you can still decode that Oops with ksymoops.
150
151 Module-Init-Tools
152 -----------------
153
154 A new module loader is now in the kernel that requires module-init-tools
155 to use.  It is backward compatible with the 2.4.x series kernels.
156
157 Mkinitrd
158 --------
159
160 These changes to the /lib/modules file tree layout also require that
161 mkinitrd be upgraded.
162
163 E2fsprogs
164 ---------
165
166 The latest version of e2fsprogs fixes several bugs in fsck and
167 debugfs.  Obviously, it's a good idea to upgrade.
168
169 JFSutils
170 --------
171
172 The jfsutils package contains the utilities for the file system.
173 The following utilities are available:
174 o fsck.jfs - initiate replay of the transaction log, and check
175   and repair a JFS formatted partition.
176 o mkfs.jfs - create a JFS formatted partition.
177 o other file system utilities are also available in this package.
178
179 Reiserfsprogs
180 -------------
181
182 The reiserfsprogs package should be used for reiserfs-3.6.x
183 (Linux kernels 2.4.x). It is a combined package and contains working
184 versions of mkreiserfs, resize_reiserfs, debugreiserfs and
185 reiserfsck. These utils work on both i386 and alpha platforms.
186
187 Xfsprogs
188 --------
189
190 The latest version of xfsprogs contains mkfs.xfs, xfs_db, and the
191 xfs_repair utilities, among others, for the XFS filesystem.  It is
192 architecture independent and any version from 2.0.0 onward should
193 work correctly with this version of the XFS kernel code (2.6.0 or
194 later is recommended, due to some significant improvements).
195
196 PCMCIAutils
197 -----------
198
199 PCMCIAutils replaces pcmcia-cs (see below). It properly sets up
200 PCMCIA sockets at system startup and loads the appropriate modules
201 for 16-bit PCMCIA devices if the kernel is modularized and the hotplug
202 subsystem is used.
203
204 Pcmcia-cs
205 ---------
206
207 PCMCIA (PC Card) support is now partially implemented in the main
208 kernel source. The "pcmciautils" package (see above) replaces pcmcia-cs
209 for newest kernels.
210
211 Quota-tools
212 -----------
213
214 Support for 32 bit uid's and gid's is required if you want to use
215 the newer version 2 quota format.  Quota-tools version 3.07 and
216 newer has this support.  Use the recommended version or newer
217 from the table above.
218
219 Intel IA32 microcode
220 --------------------
221
222 A driver has been added to allow updating of Intel IA32 microcode,
223 accessible as both a devfs regular file and as a normal (misc)
224 character device.  If you are not using devfs you may need to:
225
226 mkdir /dev/cpu
227 mknod /dev/cpu/microcode c 10 184
228 chmod 0644 /dev/cpu/microcode
229
230 as root before you can use this.  You'll probably also want to
231 get the user-space microcode_ctl utility to use with this.
232
233 Powertweak
234 ----------
235
236 If you are running v0.1.17 or earlier, you should upgrade to
237 version v0.99.0 or higher. Running old versions may cause problems
238 with programs using shared memory.
239
240 udev
241 ----
242 udev is a userspace application for populating /dev dynamically with
243 only entries for devices actually present. udev replaces devfs.
244
245 FUSE
246 ----
247
248 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
251 Networking
252 ==========
253
254 General changes
255 ---------------
256
257 If you have advanced network configuration needs, you should probably
258 consider using the network tools from ip-route2.
259
260 Packet Filter / NAT
261 -------------------
262 The packet filtering and NAT code uses the same tools like the previous 2.4.x
263 kernel series (iptables).  It still includes backwards-compatibility modules
264 for 2.2.x-style ipchains and 2.0.x-style ipfwadm.
265
266 PPP
267 ---
268
269 The PPP driver has been restructured to support multilink and to
270 enable it to operate over diverse media layers.  If you use PPP,
271 upgrade pppd to at least 2.4.0.
272
273 If you are not using devfs, you must have the device file /dev/ppp
274 which can be made by:
275
276 mknod /dev/ppp c 108 0
277
278 as root.
279
280 If you use devfsd and build ppp support as modules, you will need
281 the following in your /etc/devfsd.conf file:
282
283 LOOKUP  PPP     MODLOAD
284
285 Isdn4k-utils
286 ------------
287
288 Due to changes in the length of the phone number field, isdn4k-utils
289 needs to be recompiled or (preferably) upgraded.
290
291 NFS-utils
292 ---------
293
294 In 2.4 and earlier kernels, the nfs server needed to know about any
295 client that expected to be able to access files via NFS.  This
296 information would be given to the kernel by "mountd" when the client
297 mounted the filesystem, or by "exportfs" at system startup.  exportfs
298 would take information about active clients from /var/lib/nfs/rmtab.
299
300 This approach is quite fragile as it depends on rmtab being correct
301 which is not always easy, particularly when trying to implement
302 fail-over.  Even when the system is working well, rmtab suffers from
303 getting lots of old entries that never get removed.
304
305 With 2.6 we have the option of having the kernel tell mountd when it
306 gets a request from an unknown host, and mountd can give appropriate
307 export information to the kernel.  This removes the dependency on
308 rmtab and means that the kernel only needs to know about currently
309 active clients.
310
311 To enable this new functionality, you need to:
312
313   mount -t nfsd nfsd /proc/fs/nfs
314
315 before running exportfs or mountd.  It is recommended that all NFS
316 services be protected from the internet-at-large by a firewall where
317 that is possible.
318
319 Getting updated software
320 ========================
321
322 Kernel compilation
323 ******************
324
325 gcc 2.95.3
326 ----------
327 o  <ftp://ftp.gnu.org/gnu/gcc/gcc-2.95.3.tar.gz>
328
329 Make
330 ----
331 o  <ftp://ftp.gnu.org/gnu/make/>
332
333 Binutils
334 --------
335 o  <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
336
337 System utilities
338 ****************
339
340 Util-linux
341 ----------
342 o  <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
343
344 Ksymoops
345 --------
346 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
347
348 Module-Init-Tools
349 -----------------
350 o  <ftp://ftp.kernel.org/pub/linux/kernel/people/rusty/modules/>
351
352 Mkinitrd
353 --------
354 o  <ftp://rawhide.redhat.com/pub/rawhide/SRPMS/SRPMS/>
355
356 E2fsprogs
357 ---------
358 o  <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
359
360 JFSutils
361 --------
362 o  <http://jfs.sourceforge.net/>
363
364 Reiserfsprogs
365 -------------
366 o  <http://www.namesys.com/pub/reiserfsprogs/reiserfsprogs-3.6.3.tar.gz>
367
368 Xfsprogs
369 --------
370 o  <ftp://oss.sgi.com/projects/xfs/download/>
371
372 Pcmciautils
373 -----------
374 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
375
376 Pcmcia-cs
377 ---------
378 o  <http://pcmcia-cs.sourceforge.net/>
379
380 Quota-tools
381 ----------
382 o  <http://sourceforge.net/projects/linuxquota/>
383
384 DocBook Stylesheets
385 -------------------
386 o  <http://nwalsh.com/docbook/dsssl/>
387
388 XMLTO XSLT Frontend
389 -------------------
390 o  <http://cyberelk.net/tim/xmlto/>
391
392 Intel P6 microcode
393 ------------------
394 o  <http://www.urbanmyth.org/microcode/>
395
396 Powertweak
397 ----------
398 o  <http://powertweak.sourceforge.net/>
399
400 udev
401 ----
402 o <http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html>
403
404 FUSE
405 ----
406 o <http://sourceforge.net/projects/fuse>
407
408 Networking
409 **********
410
411 PPP
412 ---
413 o  <ftp://ftp.samba.org/pub/ppp/ppp-2.4.0.tar.gz>
414
415 Isdn4k-utils
416 ------------
417 o  <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/isdn4k-utils.v3.1pre1.tar.gz>
418
419 NFS-utils
420 ---------
421 o  <http://sourceforge.net/project/showfiles.php?group_id=14>
422
423 Iptables
424 --------
425 o  <http://www.iptables.org/downloads.html>
426
427 Ip-route2
428 ---------
429 o  <ftp://ftp.tux.org/pub/net/ip-routing/iproute2-2.2.4-now-ss991023.tar.gz>
430
431 OProfile
432 --------
433 o  <http://oprofile.sf.net/download/>
434
435 NFS-Utils
436 ---------
437 o  <http://nfs.sourceforge.net/>
438