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