Fix kerberos5 build by adding some headers files. These should be generated on
[dragonfly.git] / UPDATING
1 $DragonFly: src/UPDATING,v 1.10 2004/11/23 02:20:40 hmp Exp $
2
3 Updating Information for DragonFly users.
4
5 This file should warn you of any pitfalls which you might need to work around
6 when trying to update your DragonFly system.
7
8 If you discover any problem, please contact the bugs@lists.dragonflybsd.org
9 mailing list with the details.
10
11 ------------------------------------------------------------------------------
12
13 > Required user and group IDs when upgrading from either FreeBSD or DragonFly
14 ---------------------
15
16 The following users may be missing from your password file.  Use vipw and
17 add any that are missing:
18
19 smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
20 _pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
21 _ntp:*:65:65::0:0:ntpd privsep user:/var/empty:/sbin/nologin
22
23 The following groups may be missing from your group file.  Use vi /etc/group
24 and add any that are missing:
25
26 smmsp:*:25:
27 authpf:*:63:
28 _pflogd:*:64:
29 _ntp:*:65:
30
31
32 > Upgrading to DragonFly from FreeBSD
33 ---------------------
34
35 You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
36 FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
37 FreeBSD.  Note that the DragonFly buildworld target does not try to reuse
38 make depend information, it starts from scratch, so no pre-cleaning of the
39 object hierarchy is necessary.
40
41         # get the CVS repository (it is placed in /home/dcvs, 500MB).
42         # Please use the -h option and a mirror site to pull the 
43         # initial repository, but feel free to use the main repository
44         # machine to pull updates.
45         cvsup /usr/share/examples/cvsup/DragonFly-supfile
46         # install the source from the CVS hierarchy (remove preexisting
47         # FreeBSD src first) (500MB)
48         cd /usr
49         rm -rf src
50         cvs -R -d /home/dcvs checkout src
51         cvs -R -d /home/dcvs checkout dfports
52
53         # build it (500MB used in /usr/obj)
54         #
55         cd /usr/src
56         make buildworld
57         make buildkernel KERNCONF=<KERNELNAME>
58
59 Once you have built DragonFly you have to install it over FreeBSD.  Since
60 DragonFly does not track changes made by FreeBSD to its include file 
61 hierarchy and include file pollution can cause all sorts of unexpected
62 compilation issues to come up, it is best to wipe your include hierarchy
63 prior to installing DragonFly.  Note that you should not wipe any installed
64 FreeBSD header files or binaries until after you have successfully completed
65 the build steps above.
66
67         rm -rf /usr/include
68         mkdir /usr/include
69         make installkernel KERNCONF=<KERNELNAME>
70         make installworld
71
72 Then you need to upgrade your /etc.  DragonFly's 'make upgrade' target 
73 will unconditionally upgrade the /etc files that sysops do not usually
74 mess around with, such as the files in /etc/rc.d.  If you are unsure we 
75 recommend that you make a backup of your /etc before applying this step.
76 Note that DragonFly's RC system is basically RCNG from FreeBSD-5, but
77 there are some differences in the contents of the RC files.
78
79         make upgrade
80
81 Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
82 /usr/bin, and /usr/lib, and remove any stale files that you find.
83
84 ------------------------------------------------------------------------------
85
86 > Upgrading DragonFly on an existing DragonFly system.
87 ---------------------
88
89 The best way to upgrade DragonFly is to maintain a copy of the DragonFly
90 CVS repository via cvsup and to checkout the source base and DragonFly
91 ports via this repository.   The repository is stored in /home/dcvs by
92 default and requires about 500MB of disk space.  The checked out source
93 tree (/usr/src) requires about 500MB of disk space, and the build will
94 eat around 500MB of space out of /usr/obj.  To maintain the build you 
95 should reserve at least 2GB of disk space, and 3GB if you have the space.
96
97 Note: most people run cvsup via a root cron job to keep the repository up to
98 date.  Please limit such automatic updates to once a day and try to randomize
99 the hour and minute in the cron job a bit to avoid pileups.
100
101         # get the CVS repository (it is placed in /home/dcvs)
102         cvsup /usr/share/examples/cvsup/DragonFly-supfile
103         # install the source from the CVS hierarchy
104         cd /usr
105         cvs -R -d /home/dcvs checkout src
106         cvs -R -d /home/dcvs checkout dfports
107
108 Once you have the repository and broken out sources you can decide whether to
109 update your sources from the repository automatically or manually.  Since
110 you are tracking changes made to DragonFly, it is usually a good idea to
111 update the sources manually:
112
113         cd /usr/src
114         cvs update
115
116 To upgrade a DragonFly system from sources you run the following sequence:
117
118         cd /usr/src
119         make buildworld
120         make buildkernel KERNCONF=<KERNELNAME>
121         make installkernel KERNCONF=<KERNELNAME>
122         make installworld
123
124 You will also want to run the 'upgrade' target to upgrade your /etc.  The
125 upgrade target is aware of stale files created by older DragonFly 
126 installations and should delete them automatically.
127
128         make upgrade
129
130 If you are using 'config' manually from /usr/src/sys/i386/conf/BLAH, note 
131 that the build will use the current DragonFly environment rather then
132 the post-build environment from the last buildworld.   For this reason manual
133 configs are discouraged.  The proper way to build a kernel is to use the
134 'buildkernel' or 'quickkernel' target in /usr/src.
135
136 Once you've done a full build of the world and kernel you can do incremental
137 upgrades of either by using the 'quickworld' and 'quickkernel' targets
138 instead of 'buildworld' and 'buildkernel'.  If you have any problems with
139 the quick targets, try doing a cvsup, cvs update, and then a full buildworld
140 and buildkernel as shown above, before asking for help.
141
142 > Kerberos IV
143 -------------
144
145 Kerberos IV (eBones) was removed from the tree, please consider moving to
146 Kerberos 5 (Heimdal).
147
148 > FreeBSD and DragonFly ports
149 -----------------------------
150
151 DragonFly will eventually have its own package management system but at the
152 moment we leverage off of the FreeBSD ports system.  You should maintain
153 /usr/ports from the FreeBSD cvs repository via cvsup just like you do now.
154
155 DragonFly has its own 'port overrides' hierarchy in /usr/dfports.  You can
156 check this out of the DragonFly cvs repository using:
157
158 cd /usr
159 cvs -R -d /cvs checkout dfports
160
161 You may wish to use a consolidated distfiles directory, in which case you
162 should make /usr/dfports/distfiles a softlink to your existing distfiles
163 directory (typically /usr/ports/distfiles).
164
165 Be sure that you have installed 'relpath' from the DragonFly sources
166 (/usr/src/usr.bin/relpath) as well as the updated /usr/share/mk files from
167 /usr/src/share/mk.  As a test you can cd into /usr/ports/sysutils/cpdup and
168 build the port.  Dragonfly should contain an override and you should see a
169 warning message that the DragonFly override is being build instead when you
170 build it from the FreeBSD ports.
171