Add missing documentation to rtd jobs

Change-Id: I1e0f97f3824aef4c18c4975931b388a41686e8bd
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/jjb/lf-rtd-jobs.yaml b/jjb/lf-rtd-jobs.yaml
index 64c6dac..9feaec1 100644 (file)
--- a/jjb/lf-rtd-jobs.yaml
+++ b/jjb/lf-rtd-jobs.yaml
@@ -74,18 +74,22 @@
     #
     # Required parameters:
     #
+    #     :build-node: The node to run build on.
+    #     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+    #         be configured in defaults.yaml)
     #     :rtd-project: This is the name of the project on ReadTheDocs.org.
     #
     # Optional parameters:
     #
     #     :branch: Git branch to fetch for the build. (default: master)
     #     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    #     :build-node: The node to run build on.
     #     :build-timeout: Timeout in seconds before aborting build. (default: 15)
     #     :git-url: base URL of git project. (default: https://github.com)
     #     :project-pattern: Project to trigger build against. (default: **)
     #     :stream: Keyword that can be used to represent a release code-name.
     #         Often the same as the branch. (default: master)
+    #     :submodule-recursive: Whether to checkout submodules recursively.
+    #         (default: true)
     #
     #     :gerrit_merge_triggers: Override Gerrit Triggers.
     #     :gerrit_trigger_file_paths: Override file paths which can be used to
@@ -172,7 +176,13 @@
     name: lf-rtd-verify
     # Verify job which runs a tox build of the docs project
     #
-    # Optional parameters:
+    # Required Parameters:
+    #
+    #     :build-node: The node to run build on.
+    #     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+    #         be configured in defaults.yaml)
+    #
+    # Optional Parameters:
     #
     #     :branch: Git branch to fetch for the build. (default: master)
     #     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)