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