- Clarify the definitions of b_bufsize, b_bcount, and b_resid.
[dragonfly.git] / UPDATING
... / ...
CommitLineData
1$DragonFly: src/UPDATING,v 1.19 2006/01/31 09:45:30 swildner Exp $
2
3Updating Information for DragonFly users.
4
5This file should warn you of any pitfalls which you might need to work around
6when trying to update your DragonFly system.
7
8If you discover any problem, please contact the bugs@lists.dragonflybsd.org
9mailing list with the details.
10
11------------------------------------------------------------------------------
12
13> Updating from pre-1.2 systems or FreeBSD 4.x to DragonFly 1.3+ (either
14 PREVIEW or HEAD)
15---------------------
16
17The compatiblity shims for the build environment have been removed, you
18have to update to DragonFly 1.2 release branch first.
19
20The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
21The existing configuration can be converted using /etc/pam.d/convert.sh.
22Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
23the pam_skey.so module was retired, you have to remove it manually from
24your configuration, when you convert it.
25
26> Required user and group IDs when upgrading from either FreeBSD or DragonFly
27---------------------
28
29The following users may be missing from your password file. Use vipw and
30add any that are missing:
31
32smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
33_pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
34_ntp:*:65:65::0:0:ntpd privsep user:/var/empty:/sbin/nologin
35
36The following groups may be missing from your group file. Use vi /etc/group
37and add any that are missing:
38
39smmsp:*:25:
40authpf:*:63:
41_pflogd:*:64:
42_ntp:*:65:
43
44
45> Upgrading to DragonFly from FreeBSD
46---------------------
47
48You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
49FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
50FreeBSD. Note that the DragonFly buildworld target does not try to reuse
51make depend information, it starts from scratch, so no pre-cleaning of the
52object hierarchy is necessary.
53
54 # get the CVS repository (it is placed in /home/dcvs, 500MB).
55 # Please use the -h option and a mirror site to pull the
56 # initial repository, but feel free to use the main repository
57 # machine to pull updates.
58 cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
59 # install the source from the CVS hierarchy (remove preexisting
60 # FreeBSD src first) (500MB)
61 cd /usr
62 rm -rf src
63 cvs -R -d /home/dcvs checkout -P src
64
65 # build it (500MB used in /usr/obj)
66 #
67 cd /usr/src
68 make buildworld
69 make buildkernel KERNCONF=<KERNELNAME>
70
71Once you have built DragonFly you have to install it over FreeBSD. Since
72DragonFly does not track changes made by FreeBSD to its include file
73hierarchy and include file pollution can cause all sorts of unexpected
74compilation issues to come up, it is best to wipe your include hierarchy
75prior to installing DragonFly. Note that you should not wipe any installed
76FreeBSD header files or binaries until after you have successfully completed
77the build steps above.
78
79 rm -rf /usr/include
80 mkdir /usr/include
81 make installkernel KERNCONF=<KERNELNAME>
82 make installworld
83
84Then you need to upgrade your system. DragonFly's 'make upgrade' target
85will unconditionally upgrade the /etc files that sysops do not usually
86mess around with, such as the files in /etc/rc.d. It will also remove any
87obsolete files such as utilities and manpages that have been removed from
88the system since the version you're coming from. If you are unsure we
89recommend that you make a backup of at least your /etc before applying
90this step. Note that DragonFly's RC system is basically RCNG from
91FreeBSD-5, but there are some differences in the contents of the RC files.
92
93 make upgrade
94
95NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
96Doing so might leave your system in an unusable state.
97
98Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
99/usr/bin, and /usr/lib, and remove any stale files that you find. Please
100report these files to the DragonFly developers so that they can be added to
101the 'upgrade' target.
102
103------------------------------------------------------------------------------
104
105> Upgrading DragonFly on an existing DragonFly system.
106---------------------
107
108The best way to upgrade DragonFly is to maintain a copy of the DragonFly
109CVS repository via cvsup and to checkout the source base and DragonFly
110ports via this repository. The repository is stored in /home/dcvs by
111default and requires about 500MB of disk space. The checked out source
112tree (/usr/src) requires about 500MB of disk space, and the build will
113eat around 500MB of space out of /usr/obj. To maintain the build you
114should reserve at least 2GB of disk space, and 3GB if you have the space.
115
116Note: most people run cvsup via a root cron job to keep the repository up to
117date. Please limit such automatic updates to once a day and try to randomize
118the hour and minute in the cron job a bit to avoid pileups.
119
120 # get the CVS repository (it is placed in /home/dcvs)
121 cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
122 # install the source from the CVS hierarchy
123 cd /usr
124 cvs -R -d /home/dcvs checkout -P src
125
126Once you have the repository and broken out sources you can decide whether to
127update your sources from the repository automatically or manually. Since
128you are tracking changes made to DragonFly, it is usually a good idea to
129update the sources manually:
130
131 cd /usr/src
132 cvs update -dP
133
134To upgrade a DragonFly system from sources you run the following sequence:
135
136 cd /usr/src
137 make buildworld
138 make buildkernel KERNCONF=<KERNELNAME>
139 make installkernel KERNCONF=<KERNELNAME>
140 make installworld
141
142You will also want to run the 'upgrade' target to upgrade your /etc and the
143rest of your system. The upgrade target is aware of stale files created by
144older DragonFly installations and should delete them automatically.
145
146 make upgrade
147
148NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
149Doing so might leave your system in an unusable state.
150
151If you are using 'config' manually from /usr/src/sys/i386/conf/BLAH, note
152that the build will use the current DragonFly environment rather than
153the post-build environment from the last buildworld. For this reason manual
154configs are discouraged. The proper way to build a kernel is to use the
155'buildkernel' or 'quickkernel' target in /usr/src.
156
157Once you've done a full build of the world and kernel you can do incremental
158upgrades of either by using the 'quickworld' and 'quickkernel' targets
159instead of 'buildworld' and 'buildkernel'. If you have any problems with
160the quick targets, try doing a cvsup, cvs update, and then a full buildworld
161and buildkernel as shown above, before asking for help.
162
163> Kerberos IV
164-------------
165
166Kerberos IV (eBones) was removed from the tree, please consider moving to
167Kerberos 5 (Heimdal).
168
169> Package Management System
170---------------------------
171
172Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
173management system. The necessary tools to build and maintain packages
174are provided in /usr/pkg/bin and /usr/pkg/sbin. Make sure that these
175directories are in your PATH variable.
176
177In order to obtain a reasonably current snapshot of the pkgsrc tree, use
178the tarball from NetBSD:
179
180 fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
181 cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc
182
183This tree can then be kept up to date with cvs update:
184
185 cd /usr/pkgsrc; cvs up
186
187NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
188build and install the pkgsrc bootstrap manually:
189
190 cd /usr/pkgsrc/bootstrap
191 ./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg