Merge "Add sonar-prescan jobs"

[releng/global-jjb.git] / docs / jjb / lf-macros.rst

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index e628179..ff8c561 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -301,6 +301,23 @@ Runs Jenkins SonarQube plug-in.
 
 Requires ``SonarQube Scanner for Jenkins``
 
+:Optional Parameters:
+    :sonar-task: Sonar task to run. (default: "")
+    :sonar-properties: Sonar configuration properties. (default: "")
+    :sonar-java-opts: JVM options. (default: "")
+    :sonar-additional-args: Additional command line arguments. (default: "")
+
+lf-infra-sonar-with-prescan
+---------------------------
+
+Runs Jenkins SonarQube plug-in after a pre-scan builder, which is defined by
+the macro's caller.
+
+Requires ``SonarQube Scanner for Jenkins``
+
+:Required Parameters:
+    :lf-sonar-prescan: A builder that will run prior to the Sonar scan.
+
 :Optional Parameters:
     :sonar-task: Sonar task to run. (default: "")
     :sonar-properties: Sonar configuration properties. (default: "")