Make gerrit-branch-lock work for all proj/branches

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 6404cc9..f3eae1b 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -259,15 +259,16 @@ ReadTheDocs verify script. Installs and runs tox.
     :doc-dir: Document directory.
     :python-version: Python version.
 
-lf-rtdv2-build
+lf-rtdv3-build
 ---------------
 
-ReadTheDocs Version 2 verify and merge scripts.
-This is an update to the read the docs scripts that leverages the new Read the Docs v3 api
+Read the docs scripts that leverage the new Read the Docs v3 api
 `RTD v3 API <https://docs.readthedocs.io/en/stable/api/v3.html>`_
-Runs tox to verify that the docs are good and then runs the RTDv2 shell script.
+Runs tox to verify that the docs are good and then runs the RTDv3 shell script.
 This script handles creating projects as needed, assiging subprojects to the main
 read the docs project and triggering builds to update the documentation.
+Jobs will run but skip verify bits until a .readthedocs.yaml is found in the root
+of their repository.
 
 
 check-info-votes
@@ -312,8 +313,14 @@ Runs Jenkins SonarQube plug-in.
 
 Requires ``SonarQube Scanner for Jenkins``
 
+.. note:: Sonar properties can be set directly in the job definition by
+   setting the sonar-project-file to ``""`` and adding all properties under
+   ``sonar-properties``.
+
 :Optional Parameters:
     :sonar-task: Sonar task to run. (default: "")
+    :sonar-project-file: The filename for the project's properties
+        (default: "sonar-project.properties")
     :sonar-properties: Sonar configuration properties. (default: "")
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")
@@ -326,11 +333,17 @@ the macro's caller.
 
 Requires ``SonarQube Scanner for Jenkins``
 
+.. note:: Sonar properties can be set directly in the job definition by
+   setting the sonar-project-file to ``""`` and adding all properties under
+   ``sonar-properties``.
+
 :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-project-file: The filename for the project's properties
+        (default: "sonar-project.properties")
     :sonar-properties: Sonar configuration properties. (default: "")
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")