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