Document effect of setting quantity to 0 in README (#736)

This relates to #198
jenkinsci · Dec 16, 2024 · b413871 · b413871
1 parent 46058e2
commit b413871
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -101,6 +101,8 @@ pipeline {
 }
 ```
 
+Setting `quantity` to `null`, `0` or a smaller number, all available resources of that label are locked at once.
+
 #### Take first position in queue
 
 ```groovy

diff --git a/src/doc/examples/scripted-vs-declarative-pipeline.md b/src/doc/examples/scripted-vs-declarative-pipeline.md
@@ -32,3 +32,8 @@ node() {
     }
 }
 ```
+
+## Pitfalls
+
+Setting `quantity` to `null`, `0` or a smaller number, all available resources of that label are locked at once.
+See [#198 - Lock All resources by setting quantity to 0 is not documented](https://github.com/jenkinsci/lockable-resources-plugin/issues/198).
-Original file line number
+Diff line change
@@ Expand Up / @@ -101,6 +101,8 @@ pipeline { @@
     }
     ```
+    Setting `quantity` to `null`, `0` or a smaller number, all available resources of that label are locked at once.
     #### Take first position in queue
     ```groovy
@@ Expand Down @@