From 26e3be6577aaa278d0e6c1f5a600fcad79745bdf Mon Sep 17 00:00:00 2001 From: David Ostrovsky Date: Fri, 23 May 2014 08:34:07 +0200 Subject: [PATCH] Buck: Document how to install watchman Change-Id: Id03cc3447f49d6c21744181a0b702009a68678ab --- Documentation/dev-buck.txt | 49 ++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 7 deletions(-) diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt index 2bcf5c25fd..18924d3468 100644 --- a/Documentation/dev-buck.txt +++ b/Documentation/dev-buck.txt @@ -475,17 +475,52 @@ It is safe to run several buck daemons started from different project directories and they will not interfere with each other. Buck's documentation covers daemon in http://facebook.github.io/buck/command/buckd.html[buckd]. -To use `buckd` the additional watchman program must be installed, see -link:https://github.com/facebook/watchman[watchman] for details. +To use `buckd` the additional +link:https://facebook.github.io/watchman[watchman] program must be installed. + +[[watchman]] +=== Installing watchman + +Watchman is used internally by Buck to monitor directory trees and is needed +for buck daemon to work properly. Because buckd is activated by default in the +latest version of Buck, it searches for the watchman executable in the +path and issues a warning when it is not found and kills buckd. + +To prepare watchman installation on Linux: ---- - buckd - buck build gerrit - Using buckd. - [-] PARSING BUILD FILES...FINISHED 0.6s - [-] BUILDING...FINISHED 0.2s + git clone https://github.com/facebook/watchman.git + cd watchman + ./autogen.sh ---- +To install it in user home directory (without root privileges): + +---- + ./configure --prefix $HOME/watchman + make install +---- + +To install it system wide: + +---- + ./configure + make + sudo make install +---- + +Put $HOME/watchman/bin/watchman in path or link to $HOME/bin/watchman. + +To install watchman on OS X: + +---- + brew install --HEAD watchman +---- + +See the original documentation for more information: +link:https://facebook.github.io/watchman/docs/install.html[Watchman +installation]. + === Override Buck's settings Additional JVM args for Buck can be set in `.buckjavaargs` in the