[JENKINS-19843] Add an instruction to add a dependency to rebuild plu…

…gin to pom.xml.
jenkinsci · Oct 11, 2013 · aa83650 · aa83650
1 parent c91995e
commit aa83650
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/main/java/com/sonyericsson/rebuild/RebuildParameterProvider.java b/src/main/java/com/sonyericsson/rebuild/RebuildParameterProvider.java
@@ -36,6 +36,9 @@
  * If you want your custom {@link ParameterValue} to work with rebuild plugin,
  * do as followings:
  * <ol>
+ *   <li>Add a dependency to rebuild plugin to your pom.xml.
+ *       You should specify &lt;optional&gt;true&lt;/optional&gt;
+ *       to have your plugin work without rebuild plugin.</li>
  *   <li>Define a class implementing {@link RebuildParameterProvider}.</li>
  *   <li>Annotate the class with {@link Extension}.
  *       You should specify option=true in {@link Extension} annotation