xref: /freebsd/contrib/atf/FREEBSD-upgrade (revision 4ec234c813eed05c166859bba82c882e40826eb9)
1$FreeBSD$
2
3This document contains a collection of notes specific to the import
4of atf into head.  These notes are built on the instructions in
5the FreeBSD Subversion Primer that detail how to deal with vendor
6branches and you are supposed to follow those:
7
8	http://www.freebsd.org/doc/en/articles/committers-guide/subversion-primer.html
9
10The ATF source code is hosted on Google Code as a subcomponent of the
11Kyua project:
12
13	http://code.google.com/p/kyua/downloads/list
14
15and is imported into the atf vendor branch (see base/vendor/atf/).
16
17To merge the vendor branch into head do something like this:
18
19	cd .../base/head/contrib/atf
20	svn merge --accept=postpone \
21	    svn+ssh://svn.freebsd.org/base/vendor/atf/dist .
22	svn remove --force $(cat FREEBSD-Xlist)
23
24and resolve any conflicts that may arise at this point.
25
26Once this is done, you must regenerate bconfig.h.  The recommended way
27of doing so is by using the release files already imported into the
28vendor branch (which is a good justification for importing the verbatim
29sources in the first place so that this step is reproducible).  You can
30use a set of commands similar to the following:
31
32	mkdir /tmp/atf
33	cd /tmp/atf
34	.../vendor/atf/dist/configure \
35	    --prefix=/ \
36	    --exec-prefix=/usr \
37	    --datarootdir=/usr/share
38	cp bconfig.h .../base/head/contrib/atf/
39
40Please do NOT run './configure' straight from the 'dist' directory of
41the vendor branch as you easily risk committing build products into the
42tree.
43
44Lastly, with the list of old and new files in this import, make sure
45to udpate the reachover Makefiles accordingly.
46
47Test the build (keeping in mind the WITH_TESTS/WITHOUT_TESTS knobs) and,
48if all looks good, you are ready to commit all the changes in one go.
49