Skip to content

Commit

Permalink
Buck: Document Watchman bug related to symbolic links
Browse files Browse the repository at this point in the history
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] facebook/buck#341

Change-Id: I7cdc19c7245b499e71196d16aab0785dda187fa3
  • Loading branch information
davido committed Jun 16, 2015
1 parent 450b7d5 commit 44c7e61
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Documentation/dev-buck.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 44c7e61

Please sign in to comment.