Clarify some descriptions
Change-Id: I3177c468eeec3f1de49d6e2d71889c36acf202bc
diff --git a/mbed-tls-nightly-tests.yaml b/mbed-tls-nightly-tests.yaml
index 17a362e..f2eee8a 100644
--- a/mbed-tls-nightly-tests.yaml
+++ b/mbed-tls-nightly-tests.yaml
@@ -6,20 +6,17 @@
parameters:
- string:
default: ssh://git@github.com/Mbed-TLS/mbedtls.git
- description: Enter mbed TLS repo/fork
+ description: Mbed TLS repo/fork
name: MBED_TLS_REPO
trim: 'false'
- string:
default: development
- description: Enter branch or commit to test
+ description: Branch or commit to test
name: MBED_TLS_BRANCH
trim: 'false'
- bool:
default: true
- description: |-
- Run basic-build-test.sh
-
- (Note, this does not work on mbedtls-2.1).
+ description: Run basic-build-test.sh (test coverage measurement)
name: RUN_BASIC_BUILD_TEST
- bool:
default: true
diff --git a/mbed-tls-restricted-pr-test-parametrized.yaml b/mbed-tls-restricted-pr-test-parametrized.yaml
index 94096f9..ea3f8cc 100644
--- a/mbed-tls-restricted-pr-test-parametrized.yaml
+++ b/mbed-tls-restricted-pr-test-parametrized.yaml
@@ -11,27 +11,27 @@
trim: 'false'
- string:
default: ssh://git@github.com/Mbed-TLS/mbedtls-restricted.git
- description: Enter mbed TLS repo/fork
+ description: Mbed TLS repo/fork
name: MBED_TLS_REPO
trim: 'true'
- string:
default: development-restricted
- description: Enter branch or commit to test
+ description: Branch or commit to test
name: MBED_TLS_BRANCH
trim: 'false'
- string:
default: ssh://git@github.com:Mbed-TLS/mbedtls-framework.git
- description: Enter Framework repo/fork to override the one specififed in the Mbed TLS branch (only used if FRAMEWORK_BRANCH is also set)
+ description: Framework repo/fork to override the one specified in the Mbed TLS branch (only used if FRAMEWORK_BRANCH is also set)
name: FRAMEWORK_REPO
trim: 'true'
- string:
default: ''
- description: Enter Framework branch to override the one specififed in the Mbed TLS branch.
+ description: Framework branch/sha to override the sha specified in the Mbed TLS branch
name: FRAMEWORK_BRANCH
trim: 'false'
- bool:
default: false
- description: Run the basic FreeBSD PR job scripts
+ description: Run a selection of all.sh on FreeBSD
name: RUN_FREEBSD
- bool:
default: false
@@ -39,7 +39,7 @@
name: RUN_WINDOWS_TEST
- bool:
default: false
- description: Run all.sh tests
+ description: Run all.sh (excluding release components) on Linux
name: RUN_ALL_SH
- bool:
default: false
diff --git a/mbedtls-dockerfile-builder.yaml b/mbedtls-dockerfile-builder.yaml
index 2f614eb..07d73ed 100644
--- a/mbedtls-dockerfile-builder.yaml
+++ b/mbedtls-dockerfile-builder.yaml
@@ -1,6 +1,6 @@
- job:
concurrent: true
- description: Dockerfile building job.
+ description: Dockerfile building job
disabled: false
dsl: |-
timestamps {
@@ -74,12 +74,12 @@
parameters:
- string:
default: ssh://git@github.com/Mbed-TLS/mbedtls-test.git
- description: Enter mbed TLS test repo/fork
+ description: Mbed TLS test repo/fork
name: MBED_TLS_TEST_REPO
trim: 'false'
- string:
default: main
- description: Enter branch or commit to build dockerfile from
+ description: Branch or commit to build Dockerfile from
name: MBED_TLS_TEST_BRANCH
trim: 'false'
- bool:
@@ -88,7 +88,7 @@
name: BUILD_16_04_DOCKERFILE
- string:
default: ubuntu-16.04-testing
- description: Enter tag for Ubuntu 16.04 Docker image being built
+ description: Tag for the Ubuntu 16.04 Docker image being built
name: TAG_FOR_16_04_DOCKERFILE
trim: 'false'
- bool:
@@ -97,7 +97,7 @@
name: BUILD_18_04_DOCKERFILE
- string:
default: ubuntu-18.04-testing
- description: Enter tag for Ubuntu 18.04 Docker image being built
+ description: Tag for the Ubuntu 18.04 Docker image being built
name: TAG_FOR_18_04_DOCKERFILE
trim: 'false'
- bool:
@@ -106,7 +106,7 @@
name: BUILD_20_04_DOCKERFILE
- string:
default: ubuntu-20.04-testing
- description: Enter tag for Ubuntu 20.04 Docker image being built
+ description: Tag for the Ubuntu 20.04 Docker image being built
name: TAG_FOR_20_04_DOCKERFILE
trim: 'false'
project-type: pipeline
diff --git a/mbedtls-release-ci-testing.yaml b/mbedtls-release-ci-testing.yaml
index 594e67f..734e1fb 100644
--- a/mbedtls-release-ci-testing.yaml
+++ b/mbedtls-release-ci-testing.yaml
@@ -6,22 +6,22 @@
parameters:
- string:
default: ssh://git@github.com/Mbed-TLS/mbedtls.git
- description: Enter mbed TLS repo/fork
+ description: Mbed TLS repo/fork
name: MBED_TLS_REPO
trim: 'true'
- string:
default: development
- description: Enter branch or commit to test
+ description: Branch or commit to test
name: MBED_TLS_BRANCH
trim: 'true'
- string:
default: ssh://git@github.com:Mbed-TLS/mbedtls-framework.git
- description: Enter Framework repo/fork to override the one specififed in the Mbed TLS branch (only used if FRAMEWORK_BRANCH is also set)
+ description: Framework repo/fork to override the one specified in the Mbed TLS branch (only used if FRAMEWORK_BRANCH is also set)
name: FRAMEWORK_REPO
trim: 'true'
- string:
default: ''
- description: Enter Framework branch to override the one specififed in the Mbed TLS branch.
+ description: Framework branch/sha to override the sha specified in the Mbed TLS branch
name: FRAMEWORK_BRANCH
trim: 'false'
- bool:
@@ -30,7 +30,7 @@
name: RUN_BASIC_BUILD_TEST
- bool:
default: false
- description: Run all.sh on Linux
+ description: Run all.sh (complete) on Linux
name: RUN_ALL_SH
- bool:
default: false
@@ -42,7 +42,7 @@
name: RUN_WINDOWS_TEST
- bool:
default: false
- description: Push head to coverity branch, triggering a scan (development only)
+ description: Push head to coverity branch, triggering a scan (only done for the development branch)
name: PUSH_COVERITY
- string:
name: TEST_BRANCH
diff --git a/mbedtls-restricted-release-new.yaml b/mbedtls-restricted-release-new.yaml
index 6b17dc2..9ccaf25 100644
--- a/mbedtls-restricted-release-new.yaml
+++ b/mbedtls-restricted-release-new.yaml
@@ -6,21 +6,21 @@
parameters:
- string:
default: ssh://git@github.com/Mbed-TLS/mbedtls-restricted.git
- description: Enter mbed TLS repo/fork
+ description: Mbed TLS repo/fork
name: MBED_TLS_REPO
trim: 'true'
- string:
default: development-restricted
- description: Enter branch or commit to test
+ description: Branch or commit to test
name: MBED_TLS_BRANCH
trim: 'true'
- bool:
default: true
- description: Run basic-build-test.sh
+ description: Run basic-build-test.sh (test coverage measurement)
name: RUN_BASIC_BUILD_TEST
- bool:
default: true
- description: Run all.sh on Linux
+ description: Run all.sh (complete) on Linux
name: RUN_ALL_SH
- bool:
default: true