Merge "Refactor: Extract group list manipulation"
diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt
index 0bf44d0..3b11382 100644
--- a/Documentation/dev-buck.txt
+++ b/Documentation/dev-buck.txt
@@ -389,6 +389,21 @@
/home/<user>/projects/jgit/org.eclipse.jgit/target/org.eclipse.jgit-3.3.0-SNAPSHOT.jar
----
+After `buck clean` and `buck build lib/jgit:jgit` the symbolic link that was
+created the first time is lost due to Buck's caching mechanism. This means that
+when a new version of the local artifact is deployed (by running `mvn package`
+in the JGit project in the example above), Buck is not aware of it, because it
+still has a stale version of it in its cache.
+
+To solve this problem and re-create the symbolic link, you don't need to wipe out
+the entire Buck cache. Just rebuilding the target with the `--no-cache` option
+does the job:
+
+----
+ buck clean
+ buck build --no-cache lib/jgit:jgit
+----
+
== Building against artifacts from custom Maven repositories
To build against custom Maven repositories, two modes of operations are
@@ -448,6 +463,25 @@
EOF
----
+[[clean-cache]]
+=== Cleaning The Buck Cache
+
+The cache for the Gerrit Code Review project is located in
+`~/.gerritcodereview/buck-cache/cache`.
+
+The Buck cache should never need to be manually deleted. If you find yourself
+deleting the Buck cache regularly, then it is likely that there is something
+wrong with your environment or your workflow.
+
+If you really do need to clean the cache manually, then:
+
+----
+ rm -rf ~/.gerritcodereview/buck-cache/cache
+----
+
+Note that the root `buck-cache` folder should not be deleted as this is where
+downloaded artifacts are stored.
+
[[buck-daemon]]
=== Using Buck daemon
@@ -473,7 +507,7 @@
Prepend the variable to Buck invocation instead:
----
- $ NO_BUCKD=1 buck build gerrit
+ NO_BUCKD=1 buck build gerrit
----
[[watchman]]
@@ -537,13 +571,13 @@
needs to be repeated, the unit test cache for that test must be removed first:
----
- $ rm -rf buck-out/bin/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/group/.AddRemoveGroupMembersIT/
+ rm -rf buck-out/bin/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/group/.AddRemoveGroupMembersIT/
----
After clearing the cache, the test can be run again:
----
- $ buck test //gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/group:AddRemoveGroupMembersIT
+ buck test //gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/group:AddRemoveGroupMembersIT
TESTING //gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/group:AddRemoveGroupMembersIT
PASS 14,9s 8 Passed 0 Failed com.google.gerrit.acceptance.rest.group.AddRemoveGroupMembersIT
TESTS PASSED
diff --git a/Documentation/dev-contributing.txt b/Documentation/dev-contributing.txt
index d8d1f61..6dc8d1c 100644
--- a/Documentation/dev-contributing.txt
+++ b/Documentation/dev-contributing.txt
@@ -78,6 +78,20 @@
* Include a Bug: Issue <#> line if fixing a Gerrit issue
* Include a Change-Id line
+=== Setting up Vim for Git commit message
+
+Git uses Vim as the default commit message editor. Put this into your
+$HOME/.vimrc file to configure Vim for Git commit message formatting
+and writing:
+
+====
+ " Enable spell checking, which is not on by default for commit messages.
+ au FileType gitcommit setlocal spell
+
+ " Reset textwidth if you've previously overridden it.
+ au FileType gitcommit setlocal textwidth=72
+====
+
=== A sample good Gerrit commit message:
====
