From 44c7e6160179c6314ce449f4283e504bd5cdf342 Mon Sep 17 00:00:00 2001 From: David Ostrovsky Date: Tue, 16 Jun 2015 08:58:48 +0200 Subject: [PATCH] Buck: Document Watchman bug related to symbolic links Buck has currently one critical bug when Buck daemon is used in combination with symbolic links: [1]. Document the workaround not to use Buck daemon in this scenario. [1] https://github.com/facebook/buck/issues/341 Change-Id: I7cdc19c7245b499e71196d16aab0785dda187fa3 --- Documentation/dev-buck.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt index 89cd849f2b..bbc9ae25f3 100644 --- a/Documentation/dev-buck.txt +++ b/Documentation/dev-buck.txt @@ -651,6 +651,22 @@ option: buck test --no-results-cache ---- +== Known issues and bugs + +=== Symbolic links and `watchman` + +`Buck` with activated `Watchman` has currently a +[known bug](https://github.com/facebook/buck/issues/341) related to +symbolic links. The symbolic links are used very often with external +plugins, that are linked per symbolic link to the plugins directory. +With this use case Buck is failing to rebuild the plugin artefact +after it was built. All attempts to convince Buck to rebuild will fail. +The only known way to recover is to weep out `buck-out` directory. The +better workaround is to avoid using Watchman in this specific use case. +Watchman can either be de-installed or disabled. See +link:#buck-daemon[Using Buck daemon] section above how to temporarily +disable `buckd`. + == Troubleshooting Buck In some cases problems with Buck itself need to be investigated. See for example