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