usb4bsd/ukbd: Adjust comment style a bit.
[dragonfly.git] / UPDATING
1 # Updating Information for DragonFly users.
2 #
3 #
4 # This file should warn you of any pitfalls which you might need to work around
5 # when trying to update your DragonFly system.  The information below is
6 # in reverse-time order, with the latest information at the top.
7 #
8 # If you discover any problem, please contact the bugs@lists.dragonflybsd.org
9 # mailing list with the details.
10
11 +-----------------------------------------------------------------------+
12 +         UPGRADING DRAGONFLY FROM 3.0 to later versions                +
13 +-----------------------------------------------------------------------+
14
15 APIC_IO OPTION REMOVED
16 ----------------------
17
18 The APIC_IO kernel option is no longer accepted after having been without
19 effect for a while. The hw.ioapic_enable tunable now serves its purpose.
20 If you have 'options APIC_IO' in your kernel config, you'll have to
21 remove it.
22
23 WATCHDOG_ENABLE & HW_WDOG OPTIONS REMOVED
24 -----------------------------------------
25
26 The wdog framework is now compiled into our kernels by default, so the
27 options are no longer needed.
28
29 DOSCMD(1) REMOVED
30 -----------------
31
32 doscmd(1) has been removed. It was i386 only. The doscmd(1) specific
33 NO_X make.conf option was removed too.
34
35 GCC 4.7
36 -------
37
38 GCC 4.7 has been brought in and replaces GCC 4.1 as DragonFly's non-
39 default compiler in base (default is still GCC 4.4).
40
41 Users who wish to build only GCC 4.4 have to replace NO_GCC41 with
42 NO_GCC47 in /etc/make.conf.
43
44 +-----------------------------------------------------------------------+
45 +         UPGRADING DRAGONFLY FROM 2.10 to later versions               +
46 +-----------------------------------------------------------------------+
47
48 SEVERAL ISA DRIVERS REMOVED
49 ---------------------------
50
51 The following ISA only drivers have been removed along with a couple of
52 associated userland tools:
53
54 aha(4)
55 asc(4) & sasc(1)
56 ctx
57 dgb(4)
58 el(4)
59 gpib
60 gsc(4) & sgsc(1)
61 ie(4)
62 labpc(4)
63 le(4)
64 mse(4)
65 rc(4)
66 rdp(4)
67 spigot
68 tw(4) & xten(1) & xtend(8)
69 wl(4) & wlconfig(8)
70 wt(4)
71
72 Note that two of these drivers (aha(4) and ie(4)) are in our GENERIC
73 config and one (aha(4)) is in our X86_64_GENERIC kernel configuration
74 file.
75
76 If buildkernel complains about any of these drivers, just remove them
77 from your kernel configuration.
78
79 BINUTILS 2.20
80 -------------
81 Binutils 2.20 has been removed in favor of Binutils 2.22.  The accepted
82 values of BINUTILSVERS are now binutils221 and binutils222 (default).
83
84 BUILDWORLD/-KERNEL PARALLELIZATION WORK
85 ---------------------------------------
86 Due to changes in the way we build with more than one make job, you
87 will have to update install(1) and mkdir(1) prior to buildworld if you
88 want to build with 'make -j':
89
90 cd /usr/src/usr.bin/xinstall; make; make install; make clean
91 cd /usr/src/bin/mkdir; make; make install; make clean
92
93 DMA(8) UPGRADE
94 --------------
95 dma(8) has been upgraded to v0.7 which no longer supports the
96 /etc/dma/virtusertable. Some of its functionality has been replaced
97 with the MASQUERADE keyword and the EMAIL environment variable (see
98 the dma(8) manual page).
99
100 +-----------------------------------------------------------------------+
101 +         UPGRADING DRAGONFLY FROM 2.8 to later versions                +
102 +-----------------------------------------------------------------------+
103
104 GCC 4.4 & BINUTILS 2.21
105 -----------------------
106
107 GCC 4.4 has been made DragonFly's default compiler and Binutils 2.21 has
108 been made DragonFly's default Binutils.
109
110 That means that any settings that set CCVER to 'gcc44' are not needed
111 anymore. Instead, CCVER can be set to 'gcc41' to go back to using
112 GCC 4.1.
113
114 It also means that 'binutils221' as a value for BINUTILSVER has no
115 effect anymore. 2.17 has been removed and 'binutils220' is available
116 as an option.
117
118 The NO_GCC44 option has been removed and will not affect the build
119 anymore. There is now a NO_GCC41 option that will prevent GCC 4.1 from
120 building in a similar fashion.
121
122 Note that you must do a full buildworld/buildkernel for upgrading.
123
124 pkg_radd settings
125 -----------------
126
127 The config file for pkg_radd has moved from /etc/settings.conf to 
128 /etc/pkg_radd.conf.  Save the contents of settings.conf before upgrading
129 if this is needed.  This warning only applies if /etc/settings.conf 
130 exists.  pkg_radd will continue to work with defaults.
131
132 +-----------------------------------------------------------------------+
133 +         20100927                                                      +
134 +         UPGRADING DRAGONFLY FROM 2.6 to 2.8 or HEAD                   +
135 +-----------------------------------------------------------------------+
136
137 OpenSSL
138 --------
139
140 OpenSSL has been upgraded, and SHLIB_MAJOR was bumped for libssh and libcrypto.
141 This shouldn't break any 3rd-party software, but you'll need to recompile your
142 3rd-party software if you want it to link against the new version of OpenSSL.
143
144 Loader
145 -------
146
147 A new loader (dloader) has been added which better handles booting from
148 multiple kernel/module versions.
149
150 To upgrade (Only for this upgrade, for post 2.8 upgrades see GENERAL below)
151
152         cd /usr/src
153         make buildworld
154         make installworld
155         make upgrade
156         make buildkernel KERNCONF=<KERNELNAME>
157         make installkernel KERNCONF=<KERNELNAME>
158
159 Note that you must installworld and run the 'upgrade' target before
160 installing the new kernel.
161
162 BIND
163 -----
164
165 BIND has been removed from the base system.  The ldns and drill tools have 
166 been added for basic functionality.  Use 'drill' where you would normally 
167 use nslookup or dig, or install BIND from pkgsrc.  It's available as 
168 net/bind95, net/bind96, or net/bind97 as of this writing.
169
170 This only affects older systems upgrading to 2.8.  New 2.8+ installs 
171 include BIND as a pkgsrc package.
172
173 +-----------------------------------------------------------------------+
174 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
175 +                               GENERAL                                 +
176 +-----------------------------------------------------------------------+
177
178 Instructions on how to obtain and maintain DragonFly source code using git
179 are in the development(7) manual page.
180
181 To upgrade a DragonFly system from sources you run the following sequence:
182
183         cd /usr/src
184         make buildworld
185         make buildkernel KERNCONF=<KERNELNAME>
186         make installkernel KERNCONF=<KERNELNAME>
187         make installworld
188
189 You will also want to run the 'upgrade' target to upgrade your /etc and the
190 rest of your system.  The upgrade target is aware of stale files created by
191 older DragonFly installations and should delete them automatically.
192
193         make upgrade
194
195 See the build(7) manual page for further information.
196
197 Once you've done a full build of the world and kernel you can do incremental
198 upgrades of either by using the 'quickworld' and 'quickkernel' targets
199 instead of 'buildworld' and 'buildkernel'.  If you have any problems with
200 the quick targets, try updating your repo first, and then a full buildworld
201 and buildkernel as shown above, before asking for help.
202
203 +-----------------------------------------------------------------------+
204 +         UPGRADING FROM DRAGONFLY <= 2.0 TO DRAGONFLY >= 2.1           +
205 +-----------------------------------------------------------------------+
206
207 In 2.1 kernel and modules has moved to boot directory.  For most cases
208 this is handled automatically by 'make upgrade'.  A few cases needs manual
209 intervention:
210
211  * When installing a kernel without first doing a make buildworld,
212    installworld and upgrade to the same DESTDIR as kernel:
213    make DESTDIR/boot directory and move kernel and modules into this boot
214    directory; also move kernel.old and modules.old.
215    Typical example is vkernel(7), use (no modules used):
216
217         cd /var/vkernel
218         mkdir boot
219         chflags noschg kernel
220         mv kernel kernel.old boot
221         chflags schg boot/kernel
222         
223  * When using a boot-only partition, /boot/loader.rc needs to be edited:
224    delete occurrences of '/boot/'.
225    These occurences can normally be deleted in any case, see loader(8).
226
227 +-----------------------------------------------------------------------+
228 +         UPGRADING FROM DRAGONFLY <= 1.8 TO DRAGONFLY >= 1.9           +
229 +-----------------------------------------------------------------------+
230
231 In 1.9 major changes to the disk management infrastructure have taken
232 place.  make upgrade may not catch all of your disk devices in /dev,
233 so after upgrading be sure to cd /dev; ./MAKEDEV <blah> where <blah>
234 are all of your disk devices.  HOWEVER, from late 2.3 on we run devfs
235 and MAKEDEV no longer exists.
236
237 The biggest changes in 1.9 are:
238
239 (1) That whole-slice devices such as da0s1 no longer share the same device
240     id as partition c devices such as da0s1c.
241
242 (2) The whole-disk device (e.g. da0) is full raw access to the disk,
243     with no snooping or reserved sectors.  Consequently you cannot run
244     disklabel on this device.  Instead you must run disklabel on a
245     whole-slice device.
246
247 (3) The 'compatibility' partitions now use slice 0 in the device name,
248     so instead of da0a you must specify da0s0a.  Also, as per (1) above,
249     accessing the disklabel for the compatibility partitions must be
250     done via slice 0 (da0s0).
251
252 (4) Many device drivers that used to fake up labels, such as CD, ACD, VN,
253     and CCD now run through the disk management layer and are assigned
254     real disk management devices.   VN and CCD in particular do not usually
255     use a MBR and disklabels must be accessed through the compatibility
256     slice 0.  Your /etc/ccd.conf file still specifies 'ccd0', though, you
257     don't name it 'ccd0s0' in the config file.
258
259 Generally speaking, you have to get used to running fdisk and disklabel on
260 the correctly specified device names.  A lot of the wiggle, such as running
261 disklabel on a partition, has been removed.
262
263 +-----------------------------------------------------------------------+
264 +         UPGRADING FROM OLDER VERSIONS OF DRAGONFLY OR FREEBSD         +
265 +-----------------------------------------------------------------------+
266
267 > Kerberos IV
268 -------------
269
270 Kerberos IV (eBones) was removed from the tree, please consider moving to
271 Kerberos 5 (Heimdal).
272
273 > Package Management System
274 ---------------------------
275
276 Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
277 management system.  The necessary tools to build and maintain packages
278 are provided in /usr/pkg/bin and /usr/pkg/sbin.  Make sure that these
279 directories are in your PATH variable.
280
281 In order to obtain a reasonably current snapshot of the pkgsrc tree, use
282 the tarball from NetBSD:
283
284         fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
285         cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc
286
287 This tree can then be kept up to date with cvs update:
288
289         cd /usr/pkgsrc; cvs up
290
291 NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
292 build and install the pkgsrc bootstrap manually:
293
294         cd /usr/pkgsrc/bootstrap
295         ./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg
296
297 +-----------------------------------------------------------------------+
298 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
299 +         UPDATING FROM PRE-1.2 SYSTEMS OR FreeBSD 4.x TO               +
300 +         DRAGONFLY 1.3+ (EITHER PREVIEW or HEAD)                       +
301 +-----------------------------------------------------------------------+
302
303 The compatibility shims for the build environment have been removed, you
304 have to update to DragonFly 1.2 release branch first.
305
306 The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
307 The existing configuration can be converted using /etc/pam.d/convert.sh.
308 Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
309 the pam_skey.so module was retired, you have to remove it manually from
310 your configuration, when you convert it.
311
312 > Required user and group IDs when upgrading from either FreeBSD or DragonFly
313 ---------------------
314
315 The following users may be missing from your password file.  Use vipw and
316 add any that are missing:
317
318 smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
319 _pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
320
321 The following groups may be missing from your group file.  Use vi /etc/group
322 and add any that are missing:
323
324 smmsp:*:25:
325 authpf:*:63:
326 _pflogd:*:64:
327
328
329 > Upgrading to DragonFly from FreeBSD
330 ---------------------
331
332 You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
333 FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
334 FreeBSD.  Note that the DragonFly buildworld target does not try to reuse
335 make depend information, it starts from scratch, so no pre-cleaning of the
336 object hierarchy is necessary.
337
338         # get the CVS repository (it is placed in /home/dcvs, 500MB).
339         # Please use the -h option and a mirror site to pull the 
340         # initial repository, but feel free to use the main repository
341         # machine to pull updates.
342         cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
343         # install the source from the CVS hierarchy (remove preexisting
344         # FreeBSD src first) (500MB)
345         cd /usr
346         rm -rf src
347         cvs -R -d /home/dcvs checkout -P src
348
349         # build it (500MB used in /usr/obj)
350         #
351         cd /usr/src
352         make buildworld
353         make buildkernel KERNCONF=<KERNELNAME>
354
355 Once you have built DragonFly you have to install it over FreeBSD.  Since
356 DragonFly does not track changes made by FreeBSD to its include file 
357 hierarchy and include file pollution can cause all sorts of unexpected
358 compilation issues to come up, it is best to wipe your include hierarchy
359 prior to installing DragonFly.  Note that you should not wipe any installed
360 FreeBSD header files or binaries until after you have successfully completed
361 the build steps above.
362
363         rm -rf /usr/include
364         mkdir /usr/include
365         make installkernel KERNCONF=<KERNELNAME>
366         make installworld
367
368 Then you need to upgrade your system.  DragonFly's 'make upgrade' target 
369 will unconditionally upgrade the /etc files that sysops do not usually
370 mess around with, such as the files in /etc/rc.d.  It will also remove any
371 obsolete files such as utilities and manpages that have been removed from
372 the system since the version you're coming from.  If you are unsure we 
373 recommend that you make a backup of at least your /etc before applying
374 this step.  Note that DragonFly's RC system is basically RCNG from
375 FreeBSD-5, but there are some differences in the contents of the RC files.
376
377         make upgrade
378
379 NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
380 Doing so might leave your system in an unusable state.
381
382 Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
383 /usr/bin, and /usr/lib, and remove any stale files that you find.  Please
384 report these files to the DragonFly developers so that they can be added to
385 the 'upgrade' target.
386