buffet: Add a HACKING file This file should contain recipes for how to make changes to buffet. It should eventually give pointers for writing in our coding style, and anything else a developer should know when hacking on buffet. BUG=None TEST=None Change-Id: I0e37864c3bd844c5d5cbd2476ef520c8c685de0e
diff --git a/buffet/HACKING b/buffet/HACKING new file mode 100644 index 0000000..d657397 --- /dev/null +++ b/buffet/HACKING
@@ -0,0 +1,16 @@ +Some common workflows for developing with buffet: + +# Tell portage that you'd like to make local changes to Buffet: +cros_workon start --board=${BOARD} platform2 + +# Edit files in platform2/buffet/ +vim ... + +# Compile and install those changes into the chroot: +USE=buffet emerge-<board> platform2 + +# Compile and run buffet unittests +USE=buffet P2_TEST_FILTER="buffet::*" FEATURES=test emerge-<board> platform2 + +# Deploy the most recently built version of buffet to a DUT: +cros deploy --board=${BOARD} <remote host> platform2