Merge "Revert refspec change breaking submodule build"
[releng/global-jjb.git] / jjb / lf-rtd-jobs.yaml
index 99d0a36..8f8ba5d 100644 (file)
@@ -2,8 +2,6 @@
 - job-group:
     name: '{project-name}-rtd-jobs'
 
-    # This job group contains all the ReadTheDocs jobs
-
     jobs:
       - gerrit-rtd-merge
       - gerrit-rtd-verify
@@ -11,8 +9,6 @@
 - job-group:
     name: '{project-name}-github-rtd-jobs'
 
-    # This job group contains all the ReadTheDocs jobs
-
     jobs:
       - github-rtd-merge
       - github-rtd-verify
@@ -23,8 +19,6 @@
 
 - lf_rtd_common: &lf_rtd_common
     name: lf-rtd-common
-    # RTD verify and merge jobs are the same except for their scm, trigger, and
-    # builders definition. This anchor is the common template.
 
     ######################
     # Default parameters #
 - lf_rtd_merge: &lf_rtd_merge
     name: lf-rtd-merge
 
-    # Merge job which triggers a POST of the docs project to readthedocs
-    #
-    # 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-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
-    #         filter which file modifications will trigger a build.
-    #         (default: - compare-type: ANT
-    #                     pattern: '**/*.rst'
-    #                   - compare-type: ANT
-    #                     pattern: '**/conf.py')
-
     ######################
     # Default parameters #
     ######################
 
 - lf_rtd_verify: &lf_rtd_verify
     name: lf-rtd-verify
-    # Verify job which runs a tox build of the docs project
-    #
-    # 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)
-    #     :build-node: The node to run build on.
-    #     :build-timeout: Timeout in seconds before aborting build. (default: 15)
-    #     :doc-dir: Directory where tox will place built docs.
-    #         as defined in the tox.ini (default: docs/_build/html)
-    #     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    #     :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_verify_triggers: Override Gerrit Triggers.
-    #     :gerrit_trigger_file_paths: Override file paths which can be used to
-    #         filter which file modifications will trigger a build.
-    #         (default: - compare-type: ANT
-    #                     pattern: '**/*.rst'
-    #                   - compare-type: ANT
-    #                     pattern: '**/conf.py')
 
     ######################
     # Default parameters #