Document a use-case of PatchSetLock

Change-Id: Ic44bdc4ee27cd868a4077c7ea38226dd29dad8df
GerritCodeReview · Aug 7, 2018 · 159f03b · 159f03b
1 parent 7ddd805
commit 159f03b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/Documentation/config-labels.txt b/Documentation/config-labels.txt
@@ -238,7 +238,9 @@ determining whether a change is submittable.
 The `PatchSetLock` function provides a locking mechanism for patch
 sets.  This function's values are not considered when determining
 whether a change is submittable. When set, no new patchsets can be
-created and rebase and abandon are blocked.
+created and rebase and abandon are blocked. This is useful to prevent
+updates to a change while (potentially expensive) CI
+validation is running.
 +
 This function is designed to allow overlapping locks, so several lock
 accounts could lock the same change.