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