Complete the renaming to TuxOnIce with function names, vars etc.
[linux-2.6/suspend2-head.git] / Documentation / Changes
blob73a8617f1861754198c18c5e7285da95358994fe
1 Intro
2 =====
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.
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).
18 Current Minimal Requirements
19 ============================
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.
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.
31 o  Gnu C                  3.2                     # gcc --version
32 o  Gnu make               3.79.1                  # 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.29                    # tune2fs
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  pcmciautils            004                     # pccardctl -V
41 o  quota-tools            3.09                    # quota -V
42 o  PPP                    2.4.0                   # pppd --version
43 o  isdn4k-utils           3.1pre1                 # isdnctrl 2>&1|grep version
44 o  nfs-utils              1.0.5                   # showmount --version
45 o  procps                 3.2.0                   # ps --version
46 o  oprofile               0.9                     # oprofiled --version
47 o  udev                   081                     # udevinfo -V
49 Kernel compilation
50 ==================
52 GCC
53 ---
55 The gcc version requirements may vary depending on the type of CPU in your
56 computer.
58 Make
59 ----
61 You will need Gnu make 3.79.1 or later to build the kernel.
63 Binutils
64 --------
66 Linux on IA-32 has recently switched from using as86 to using gas for
67 assembling the 16-bit boot code, removing the need for as86 to compile
68 your kernel.  This change does, however, mean that you need a recent
69 release of binutils.
71 System utilities
72 ================
74 Architectural changes
75 ---------------------
77 DevFS has been obsoleted in favour of udev
78 (http://www.kernel.org/pub/linux/utils/kernel/hotplug/)
80 32-bit UID support is now in place.  Have fun!
82 Linux documentation for functions is transitioning to inline
83 documentation via specially-formatted comments near their
84 definitions in the source.  These comments can be combined with the
85 SGML templates in the Documentation/DocBook directory to make DocBook
86 files, which can then be converted by DocBook stylesheets to PostScript,
87 HTML, PDF files, and several other formats.  In order to convert from
88 DocBook format to a format of your choice, you'll need to install Jade as
89 well as the desired DocBook stylesheets.
91 Util-linux
92 ----------
94 New versions of util-linux provide *fdisk support for larger disks,
95 support new options to mount, recognize more supported partition
96 types, have a fdformat which works with 2.4 kernels, and similar goodies.
97 You'll probably want to upgrade.
99 Ksymoops
100 --------
102 If the unthinkable happens and your kernel oopses, you may need the
103 ksymoops tool to decode it, but in most cases you don't.
104 In the 2.6 kernel it is generally preferred to build the kernel with
105 CONFIG_KALLSYMS so that it produces readable dumps that can be used as-is
106 (this also produces better output than ksymoops).
107 If for some reason your kernel is not build with CONFIG_KALLSYMS and
108 you have no way to rebuild and reproduce the Oops with that option, then
109 you can still decode that Oops with ksymoops.
111 Module-Init-Tools
112 -----------------
114 A new module loader is now in the kernel that requires module-init-tools
115 to use.  It is backward compatible with the 2.4.x series kernels.
117 Mkinitrd
118 --------
120 These changes to the /lib/modules file tree layout also require that
121 mkinitrd be upgraded.
123 E2fsprogs
124 ---------
126 The latest version of e2fsprogs fixes several bugs in fsck and
127 debugfs.  Obviously, it's a good idea to upgrade.
129 JFSutils
130 --------
132 The jfsutils package contains the utilities for the file system.
133 The following utilities are available:
134 o fsck.jfs - initiate replay of the transaction log, and check
135   and repair a JFS formatted partition.
136 o mkfs.jfs - create a JFS formatted partition.
137 o other file system utilities are also available in this package.
139 Reiserfsprogs
140 -------------
142 The reiserfsprogs package should be used for reiserfs-3.6.x
143 (Linux kernels 2.4.x). It is a combined package and contains working
144 versions of mkreiserfs, resize_reiserfs, debugreiserfs and
145 reiserfsck. These utils work on both i386 and alpha platforms.
147 Xfsprogs
148 --------
150 The latest version of xfsprogs contains mkfs.xfs, xfs_db, and the
151 xfs_repair utilities, among others, for the XFS filesystem.  It is
152 architecture independent and any version from 2.0.0 onward should
153 work correctly with this version of the XFS kernel code (2.6.0 or
154 later is recommended, due to some significant improvements).
156 PCMCIAutils
157 -----------
159 PCMCIAutils replaces pcmcia-cs (see below). It properly sets up
160 PCMCIA sockets at system startup and loads the appropriate modules
161 for 16-bit PCMCIA devices if the kernel is modularized and the hotplug
162 subsystem is used.
164 Pcmcia-cs
165 ---------
167 PCMCIA (PC Card) support is now partially implemented in the main
168 kernel source. The "pcmciautils" package (see above) replaces pcmcia-cs
169 for newest kernels.
171 Quota-tools
172 -----------
174 Support for 32 bit uid's and gid's is required if you want to use
175 the newer version 2 quota format.  Quota-tools version 3.07 and
176 newer has this support.  Use the recommended version or newer
177 from the table above.
179 Intel IA32 microcode
180 --------------------
182 A driver has been added to allow updating of Intel IA32 microcode,
183 accessible as a normal (misc) character device.  If you are not using
184 udev you may need to:
186 mkdir /dev/cpu
187 mknod /dev/cpu/microcode c 10 184
188 chmod 0644 /dev/cpu/microcode
190 as root before you can use this.  You'll probably also want to
191 get the user-space microcode_ctl utility to use with this.
193 Powertweak
194 ----------
196 If you are running v0.1.17 or earlier, you should upgrade to
197 version v0.99.0 or higher. Running old versions may cause problems
198 with programs using shared memory.
200 udev
201 ----
202 udev is a userspace application for populating /dev dynamically with
203 only entries for devices actually present.  udev replaces the basic
204 functionality of devfs, while allowing persistent device naming for
205 devices.
207 FUSE
208 ----
210 Needs libfuse 2.4.0 or later.  Absolute minimum is 2.3.0 but mount
211 options 'direct_io' and 'kernel_cache' won't work.
213 Networking
214 ==========
216 General changes
217 ---------------
219 If you have advanced network configuration needs, you should probably
220 consider using the network tools from ip-route2.
222 Packet Filter / NAT
223 -------------------
224 The packet filtering and NAT code uses the same tools like the previous 2.4.x
225 kernel series (iptables).  It still includes backwards-compatibility modules
226 for 2.2.x-style ipchains and 2.0.x-style ipfwadm.
231 The PPP driver has been restructured to support multilink and to
232 enable it to operate over diverse media layers.  If you use PPP,
233 upgrade pppd to at least 2.4.0.
235 If you are not using udev, you must have the device file /dev/ppp
236 which can be made by:
238 mknod /dev/ppp c 108 0
240 as root.
242 Isdn4k-utils
243 ------------
245 Due to changes in the length of the phone number field, isdn4k-utils
246 needs to be recompiled or (preferably) upgraded.
248 NFS-utils
249 ---------
251 In 2.4 and earlier kernels, the nfs server needed to know about any
252 client that expected to be able to access files via NFS.  This
253 information would be given to the kernel by "mountd" when the client
254 mounted the filesystem, or by "exportfs" at system startup.  exportfs
255 would take information about active clients from /var/lib/nfs/rmtab.
257 This approach is quite fragile as it depends on rmtab being correct
258 which is not always easy, particularly when trying to implement
259 fail-over.  Even when the system is working well, rmtab suffers from
260 getting lots of old entries that never get removed.
262 With 2.6 we have the option of having the kernel tell mountd when it
263 gets a request from an unknown host, and mountd can give appropriate
264 export information to the kernel.  This removes the dependency on
265 rmtab and means that the kernel only needs to know about currently
266 active clients.
268 To enable this new functionality, you need to:
270   mount -t nfsd nfsd /proc/fs/nfsd
272 before running exportfs or mountd.  It is recommended that all NFS
273 services be protected from the internet-at-large by a firewall where
274 that is possible.
276 Getting updated software
277 ========================
279 Kernel compilation
280 ******************
284 o  <ftp://ftp.gnu.org/gnu/gcc/>
286 Make
287 ----
288 o  <ftp://ftp.gnu.org/gnu/make/>
290 Binutils
291 --------
292 o  <ftp://ftp.kernel.org/pub/linux/devel/binutils/>
294 System utilities
295 ****************
297 Util-linux
298 ----------
299 o  <ftp://ftp.kernel.org/pub/linux/utils/util-linux/>
301 Ksymoops
302 --------
303 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/ksymoops/v2.4/>
305 Module-Init-Tools
306 -----------------
307 o  <ftp://ftp.kernel.org/pub/linux/kernel/people/rusty/modules/>
309 Mkinitrd
310 --------
311 o  <ftp://rawhide.redhat.com/pub/rawhide/SRPMS/SRPMS/>
313 E2fsprogs
314 ---------
315 o  <http://prdownloads.sourceforge.net/e2fsprogs/e2fsprogs-1.29.tar.gz>
317 JFSutils
318 --------
319 o  <http://jfs.sourceforge.net/>
321 Reiserfsprogs
322 -------------
323 o  <http://www.namesys.com/pub/reiserfsprogs/reiserfsprogs-3.6.3.tar.gz>
325 Xfsprogs
326 --------
327 o  <ftp://oss.sgi.com/projects/xfs/download/>
329 Pcmciautils
330 -----------
331 o  <ftp://ftp.kernel.org/pub/linux/utils/kernel/pcmcia/>
333 Pcmcia-cs
334 ---------
335 o  <http://pcmcia-cs.sourceforge.net/>
337 Quota-tools
338 ----------
339 o  <http://sourceforge.net/projects/linuxquota/>
341 DocBook Stylesheets
342 -------------------
343 o  <http://nwalsh.com/docbook/dsssl/>
345 XMLTO XSLT Frontend
346 -------------------
347 o  <http://cyberelk.net/tim/xmlto/>
349 Intel P6 microcode
350 ------------------
351 o  <http://www.urbanmyth.org/microcode/>
353 Powertweak
354 ----------
355 o  <http://powertweak.sourceforge.net/>
357 udev
358 ----
359 o <http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html>
361 FUSE
362 ----
363 o <http://sourceforge.net/projects/fuse>
365 Networking
366 **********
370 o  <ftp://ftp.samba.org/pub/ppp/ppp-2.4.0.tar.gz>
372 Isdn4k-utils
373 ------------
374 o  <ftp://ftp.isdn4linux.de/pub/isdn4linux/utils/isdn4k-utils.v3.1pre1.tar.gz>
376 NFS-utils
377 ---------
378 o  <http://sourceforge.net/project/showfiles.php?group_id=14>
380 Iptables
381 --------
382 o  <http://www.iptables.org/downloads.html>
384 Ip-route2
385 ---------
386 o  <ftp://ftp.tux.org/pub/net/ip-routing/iproute2-2.2.4-now-ss991023.tar.gz>
388 OProfile
389 --------
390 o  <http://oprofile.sf.net/download/>
392 NFS-Utils
393 ---------
394 o  <http://nfs.sourceforge.net/>