X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-c-cpp-jobs.rst;h=2a71cb2c6da4cfe485115f7f81d927a6d0c0f103;hb=2a948d139fc74e495bf8168072bb623b2c8bb8fe;hp=17d458140ac3e5fdf683a0176752ca6ea1e48258;hpb=9fdb611f1fce34d54be1af81d7baedb86726302c;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-c-cpp-jobs.rst b/docs/jjb/lf-c-cpp-jobs.rst
index 17d45814..2a71cb2c 100644
--- a/docs/jjb/lf-c-cpp-jobs.rst
+++ b/docs/jjb/lf-c-cpp-jobs.rst
@@ -5,6 +5,55 @@ C/C++ Jobs
 Job Templates
 =============
 
+CMake Sonar
+-----------
+
+Sonar job which runs cmake && make then publishes to Sonar.
+
+This job purposely runs on the master branch as there are configuration needed
+to support multi-branch.
+
+:Template Names:
+
+    - {project-name}-cmake-sonar
+    - gerrit-cmake-sonar
+    - github-cmake-sonar
+
+:Comment Trigger: run-sonar
+
+:Required parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Configure in
+        defaults.yaml)
+    :sonar-scanner-version: Version of sonar-scanner to install.
+    :sonarcloud-project-key: SonarCloud project key.
+    :sonarcloud-project-organization: SonarCloud project organization.
+    :sonarcloud-api-token: SonarCloud API Token.
+
+:Optional parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-timeout: Timeout in minutes before aborting build. (default: 60)
+    :cmake-opts: Parameters to pass to cmake. (default: '')
+    :cron: Cron schedule when to trigger the job. This parameter also
+        supports multiline input via YAML pipe | character in cases where
+        one may want to provide more than 1 cron timer.  (default: '@daily')
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    :install-prefix: CMAKE_INSTALL_PREFIX to use for install.
+        (default: $BUILD_DIR/output)
+    :make-opts: Parameters to pass to make. (default: '')
+    :pre-build: Shell script to run before performing build. Useful for
+        setting up dependencies. (default: '')
+    :submodule-recursive: Whether to checkout submodules recursively.
+        (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
+
+    :gerrit_sonar_triggers: Override Gerrit Triggers.
+
 CMake Stage
 -----------
 
@@ -39,14 +88,6 @@ project into a tar.xz tarball to produce a release candidate.
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :install-prefix: CMAKE_INSTALL_PREFIX to use for install.
         (default: $BUILD_DIR/output)
-
-        .. code-block:: bash
-           :caption: Example
-
-           install-prefix: |
-               #!/bin/bash
-               echo "Hello World."
-
     :make-opts: Parameters to pass to make. (default: '')
     :pre-build: Shell script to run before performing build. Useful for
         setting up dependencies. (default: '')
@@ -56,6 +97,8 @@ project into a tar.xz tarball to produce a release candidate.
         (default: true)
     :submodule-timeout: Timeout (in minutes) for checkout operation.
         (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
     :version: (default: '') Project version to stage release as. There are 2
         methods for using this value:
 
@@ -103,14 +146,6 @@ Verify job which runs cmake && make && make install to test a project build..
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :install-prefix: CMAKE_INSTALL_PREFIX to use for install.
         (default: $BUILD_DIR/output)
-
-        .. code-block:: bash
-           :caption: Example
-
-           install-prefix: |
-               #!/bin/bash
-               echo "Hello World."
-
     :make-opts: Parameters to pass to make. (default: '')
     :pre-build: Shell script to run before performing build. Useful for
         setting up dependencies. (default: '')
@@ -120,6 +155,8 @@ Verify job which runs cmake && make && make install to test a project build..
         (default: true)
     :submodule-timeout: Timeout (in minutes) for checkout operation.
         (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
     :gerrit_trigger_file_paths: Override file paths which to filter which file