[PATCH] pcmcia: update Documentation
[linux-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 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
69 Kernel compilation
70 ==================
71
72 GCC
73 ---
74
75 The gcc version requirements may vary depending on the type of CPU in your
76 computer. The next paragraph applies to users of x86 CPUs, but not
77 necessarily to users of other CPUs. Users of other CPUs should obtain
78 information about their gcc version requirements from another source.
79
80 The recommended compiler for the kernel is gcc 2.95.x (x >= 3), and it
81 should be used when you need absolute stability. You may use gcc 3.0.x
82 instead if you wish, although it may cause problems. Later versions of gcc 
83 have not received much testing for Linux kernel compilation, and there are 
84 almost certainly bugs (mainly, but not exclusively, in the kernel) that
85 will need to be fixed in order to use these compilers. In any case, using
86 pgcc instead of plain gcc is just asking for trouble.
87
88 The Red Hat gcc 2.96 compiler subtree can also be used to build this tree.
89 You should ensure you use gcc-2.96-74 or later. gcc-2.96-54 will not build
90 the kernel correctly.
91
92 In addition, please pay attention to compiler optimization.  Anything
93 greater than -O2 may not be wise.  Similarly, if you choose to use gcc-2.95.x
94 or derivatives, be sure not to use -fstrict-aliasing (which, depending on
95 your version of gcc 2.95.x, may necessitate using -fno-strict-aliasing).
96
97 Make
98 ----
99
100 You will need Gnu make 3.79.1 or later to build the kernel.
101
102 Binutils
103 --------
104
105 Linux on IA-32 has recently switched from using as86 to using gas for
106 assembling the 16-bit boot code, removing the need for as86 to compile
107 your kernel.  This change does, however, mean that you need a recent
108 release of binutils.
109
110 System utilities
111 ================
112
113 Architectural changes
114 ---------------------
115
116 DevFS has been obsoleted in favour of udev
117 (http://www.kernel.org/pub/linux/utils/kernel/hotplug/)
118
119 32-bit UID support is now in place.  Have fun!
120
121 Linux documentation for functions is transitioning to inline
122 documentation via specially-formatted comments near their
123 definitions in the source.  These comments can be combined with the
124 SGML templates in the Documentation/DocBook directory to make DocBook
125 files, which can then be converted by DocBook stylesheets to PostScript,
126 HTML, PDF files, and several other formats.  In order to convert from
127 DocBook format to a format of your choice, you'll need to install Jade as
128 well as the desired DocBook stylesheets.
129
130 Util-linux
131 ----------
132
133 New versions of util-linux provide *fdisk support for larger disks,
134 support new options to mount, recognize more supported partition
135 types, have a fdformat which works with 2.4 kernels, and similar goodies.
136 You'll probably want to upgrade.
137
138 Ksymoops
139 --------
140
141 If the unthinkable happens and your kernel oopses, you'll need a 2.4
142 version of ksymoops to decode the report; see REPORTING-BUGS in the
143 root of the Linux source for more information.
144
145 Module-Init-Tools
146 -----------------
147
148 A new module loader is now in the kernel that requires module-init-tools
149 to use.  It is backward compatible with the 2.4.x series kernels.
150
151 Mkinitrd
152 --------
153
154 These changes to the /lib/modules file tree layout also require that
155 mkinitrd be upgraded.
156
157 E2fsprogs
158 ---------
159
160 The latest version of e2fsprogs fixes several bugs in fsck and
161 debugfs.  Obviously, it's a good idea to upgrade.
162
163 JFSutils
164 --------
165
166 The jfsutils package contains the utilities for the file system.
167 The following utilities are available:
168 o fsck.jfs - initiate replay of the transaction log, and check
169   and repair a JFS formatted partition.
170 o mkfs.jfs - create a JFS formatted partition.
171 o 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 (see below). 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 Pcmcia-cs
199 ---------
200
201 PCMCIA (PC Card) support is now partially implemented in the main
202 kernel source. The "pcmciautils" package (see above) replaces pcmcia-cs
203 for newest kernels.
204
205 Quota-tools
206 -----------
207
208 Support for 32 bit uid's and gid's is required if you want to use
209 the newer version 2 quota format.  Quota-tools version 3.07 and
210 newer has this support.  Use the recommended version or newer
211 from the table above.
212
213 Intel IA32 microcode
214 --------------------
215
216 A driver has been added to allow updating of Intel IA32 microcode,
217 accessible as both a devfs regular file and as a normal (misc)
218 character device.  If you are not using devfs you may need to:
219
220 mkdir /dev/cpu
221 mknod /dev/cpu/microcode c 10 184
222 chmod 0644 /dev/cpu/microcode
223
224 as root before you can use this.  You'll probably also want to
225 get the user-space microcode_ctl utility to use with this.
226
227 Powertweak
228 ----------
229
230 If you are running v0.1.17 or earlier, you should upgrade to
231 version v0.99.0 or higher. Running old versions may cause problems
232 with programs using shared memory.
233
234 udev
235 ----
236 udev is a userspace application for populating /dev dynamically with
237 only entries for devices actually present. udev replaces devfs.
238
239 Networking
240 ==========
241
242 General changes
243 ---------------
244
245 If you have advanced network configuration needs, you should probably
246 consider using the network tools from ip-route2.
247
248 Packet Filter / NAT
249 -------------------
250 The packet filtering and NAT code uses the same tools like the previous 2.4.x
251 kernel series (iptables).  It still includes backwards-compatibility modules
252 for 2.2.x-style ipchains and 2.0.x-style ipfwadm.
253
254 PPP
255 ---
256
257 The PPP driver has been restructured to support multilink and to
258 enable it to operate over diverse media layers.  If you use PPP,
259 upgrade pppd to at least 2.4.0.
260
261 If you are not using devfs, you must have the device file /dev/ppp
262 which can be made by:
263
264 mknod /dev/ppp c 108 0
265
266 as root.
267
268 If you use devfsd and build ppp support as modules, you will need
269 the following in your /etc/devfsd.conf file:
270
271 LOOKUP  PPP     MODLOAD
272
273 Isdn4k-utils
274 ------------
275
276 Due to changes in the length of the phone number field, isdn4k-utils
277 needs to be recompiled or (preferably) upgraded.
278
279 NFS-utils
280 ---------
281
282 In 2.4 and earlier kernels, the nfs server needed to know about any
283 client that expected to be able to access files via NFS.  This
284 information would be given to the kernel by "mountd" when the client
285 mounted the filesystem, or by "exportfs" at system startup.  exportfs
286 would take information about active clients from /var/lib/nfs/rmtab.
287
288 This approach is quite fragile as it depends on rmtab being correct
289 which is not always easy, particularly when trying to implement
290 fail-over.  Even when the system is working well, rmtab suffers from
291 getting lots of old entries that never get removed.
292
293 With 2.6 we have the option of having the kernel tell mountd when it
294 gets a request from an unknown host, and mountd can give appropriate
295 export information to the kernel.  This removes the dependency on
296 rmtab and means that the kernel only needs to know about currently
297 active clients.
298
299 To enable this new functionality, you need to:
300
301   mount -t nfsd nfsd /proc/fs/nfs
302
303 before running exportfs or mountd.  It is recommended that all NFS
304 services be protected from the internet-at-large by a firewall where
305 that is possible.
306
307 Getting updated software
308 ========================
309
310 Kernel compilation
311 ******************
312
313 gcc 2.95.3
314 ----------
315 o  <ftp://ftp.gnu.org/gnu/gcc/gcc-2.95.3.tar.gz>
316
317 Make
318 ----
319 o  <ftp://ftp.gnu.org/gnu/make/>
320
321 Binutils
322 --------
323 o  <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
324
325 System utilities
326 ****************
327
328 Util-linux
329 ----------
330 o  <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
331
332 Ksymoops
333 --------
334 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
335
336 Module-Init-Tools
337 -----------------
338 o  <ftp://ftp.kernel.org/pub/linux/kernel/people/rusty/modules/>
339
340 Mkinitrd
341 --------
342 o  <ftp://rawhide.redhat.com/pub/rawhide/SRPMS/SRPMS/>
343
344 E2fsprogs
345 ---------
346 o  <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
347
348 JFSutils
349 --------
350 o  <http://jfs.sourceforge.net/>
351
352 Reiserfsprogs
353 -------------
354 o  <http://www.namesys.com/pub/reiserfsprogs/reiserfsprogs-3.6.3.tar.gz>
355
356 Xfsprogs
357 --------
358 o  <ftp://oss.sgi.com/projects/xfs/download/>
359
360 Pcmciautils
361 -----------
362 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
363
364 Pcmcia-cs
365 ---------
366 o  <http://pcmcia-cs.sourceforge.net/>
367
368 Quota-tools
369 ----------
370 o  <http://sourceforge.net/projects/linuxquota/>
371
372 DocBook Stylesheets
373 -------------------
374 o  <http://nwalsh.com/docbook/dsssl/>
375
376 XMLTO XSLT Frontend
377 -------------------
378 o  <http://cyberelk.net/tim/xmlto/>
379
380 Intel P6 microcode
381 ------------------
382 o  <http://www.urbanmyth.org/microcode/>
383
384 Powertweak
385 ----------
386 o  <http://powertweak.sourceforge.net/>
387
388 udev
389 ----
390 o <http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html>
391
392 Networking
393 **********
394
395 PPP
396 ---
397 o  <ftp://ftp.samba.org/pub/ppp/ppp-2.4.0.tar.gz>
398
399 Isdn4k-utils
400 ------------
401 o  <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/isdn4k-utils.v3.1pre1.tar.gz>
402
403 NFS-utils
404 ---------
405 o  <http://sourceforge.net/project/showfiles.php?group_id=14>
406
407 Iptables
408 --------
409 o  <http://www.iptables.org/downloads.html>
410
411 Ip-route2
412 ---------
413 o  <ftp://ftp.tux.org/pub/net/ip-routing/iproute2-2.2.4-now-ss991023.tar.gz>
414
415 OProfile
416 --------
417 o  <http://oprofile.sf.net/download/>
418
419 NFS-Utils
420 ---------
421 o  <http://nfs.sourceforge.net/>
422