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