svn commit: r258286 - head/contrib/atf

[Julio Merino]

Author: jmmv
Date: Sun Nov 17 23:19:06 2013
New Revision: 258286
URL: http://svnweb.freebsd.org/changeset/base/258286

Log:
  Update notes for imports of atf.
  
  This is because the atf vendor branch now includes a verbatim copy of
  the distfile sources.  As a result, the list of files to-be-removed from
  the contrib/ directory is now more aggressive (and different) and the
  upgrade notes now only describe stuff that is specific to the atf import
  and is not documented in the Subversion Primer.
  
  Approved by:	rpaulo (mentor)

Modified:
  head/contrib/atf/FREEBSD-Xlist
  head/contrib/atf/FREEBSD-upgrade

Modified: head/contrib/atf/FREEBSD-Xlist
==============================================================================
--- head/contrib/atf/FREEBSD-Xlist	Sun Nov 17 23:12:55 2013	(r258285)
+++ head/contrib/atf/FREEBSD-Xlist	Sun Nov 17 23:19:06 2013	(r258286)
@@ -1,8 +1,12 @@
+*/*/Makefile*
+*/Makefile*
+INSTALL
+Makefile*
+aclocal.m4
+admin/
+atf-*/atf-*.m4
+atf-*/atf-*.pc.in
+bconfig.h.in
 bootstrap/
-config.log
-config.status
-libtool
-Makefile
-stamp-h1
-*/*/.deps/
-*/.deps/
+configure*
+m4/

Modified: head/contrib/atf/FREEBSD-upgrade
==============================================================================
--- head/contrib/atf/FREEBSD-upgrade	Sun Nov 17 23:12:55 2013	(r258285)
+++ head/contrib/atf/FREEBSD-upgrade	Sun Nov 17 23:19:06 2013	(r258286)
@@ -1,28 +1,48 @@
 $FreeBSD$
 
-atf
+This document contains a collection of notes specific to the import
+of atf into head.  These notes are built on the instructions in
+the FreeBSD Subversion Primer that detail how to deal with vendor
+branches and you are supposed to follow those:
 
-The source code is hosted on GoogleCode as a subcomponent of the Kyua project:
+	http://www.freebsd.org/doc/en/articles/committers-guide/subversion-primer.html
 
-	http://code.google.com/p/kyua/downloads/list
-
-For the contrib directory, the sources were initially prepared like so:
-
-	./configure --prefix=/ --exec-prefix=/usr --datarootdir=/usr/share
+The ATF source code is hosted on Google Code as a subcomponent of the
+Kyua project:
 
-For the contrib directory, files and directories were pruned by:
-
-sh -c 'for F in `cat FREEBSD-Xlist`; do rm -rf ./$F ; done'
+	http://code.google.com/p/kyua/downloads/list
 
-You may check if there are any new files that we don't need.
+and is imported into the atf vendor branch (see base/vendor/atf/).
 
-The instructions for importing new release and merging to HEAD can be found
-at FreeBSD wiki:
+To merge the vendor branch into head do something like this:
 
-	http://wiki.freebsd.org/SubversionPrimer/VendorImports
+	cd .../base/head/contrib/atf
+	svn merge --accept=postpone \
+	    svn+ssh://svn.freebsd.org/base/vendor/atf/dist .
+	svn remove --force $(cat FREEBSD-Xlist)
+
+and resolve any conflicts that may arise at this point.
+
+Once this is done, you must regenerate bconfig.h.  The recommended way
+of doing so is by using the release files already imported into the
+vendor branch (which is a good justification for importing the verbatim
+sources in the first place so that this step is reproducible).  You can
+use a set of commands similar to the following:
+
+	mkdir /tmp/atf
+	cd /tmp/atf
+	.../vendor/atf/dist/configure \
+	    --prefix=/ \
+	    --exec-prefix=/usr \
+	    --datarootdir=/usr/share
+	cp bconfig.h .../base/head/contrib/atf/
+
+Please do NOT run './configure' straight from the 'dist' directory of
+the vendor branch as you easily risk committing build products into the
+tree.
 
-To make local changes to atf, simply patch and commit to the trunk
-branch (aka HEAD).  Never make local changes on the vendor branch.
+Lastly, with the list of old and new files in this import, make sure
+to udpate the reachover Makefiles accordingly.
 
-gcooper at FreeBSD.org
-5-August-2012
+Test the build (keeping in mind the WITH_TESTS/WITHOUT_TESTS knobs) and,
+if all looks good, you are ready to commit all the changes in one go.