xref: /freebsd/contrib/atf/FREEBSD-upgrade (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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 GitHub:
11
12	https://github.com/jmmv/atf
13
14and is imported into the atf vendor branch (see base/vendor/atf/).
15
16To merge the vendor branch into head do something like this:
17
18	cd .../base/head/contrib/atf
19	svn merge --accept=postpone \
20	    svn+ssh://svn.freebsd.org/base/vendor/atf/dist .
21	svn remove --force $(cat FREEBSD-Xlist)
22
23and resolve any conflicts that may arise at this point.
24
25Once this is done, you must regenerate bconfig.h.  The recommended way
26of doing so is by using the release files already imported into the
27vendor branch (which is a good justification for importing the verbatim
28sources in the first place so that this step is reproducible).  You can
29use a set of commands similar to the following:
30
31	mkdir /tmp/atf
32	cd /tmp/atf
33	.../vendor/atf/dist/configure \
34	    --prefix=/ \
35	    --exec-prefix=/usr \
36	    --datarootdir=/usr/share
37	cp bconfig.h .../base/head/contrib/atf/
38
39Please do NOT run './configure' straight from the 'dist' directory of
40the vendor branch as you easily risk committing build products into the
41tree.
42
43Lastly, with the list of old and new files in this import, make sure
44to update the reachover Makefiles accordingly.
45
46Test the build (keeping in mind the WITH_TESTS/WITHOUT_TESTS knobs) and,
47if all looks good, you are ready to commit all the changes in one go.
48