diff --git a/jenkins_jobs/modules/builders.py b/jenkins_jobs/modules/builders.py index 7ddcc174e..e7b3a8b57 100644 --- a/jenkins_jobs/modules/builders.py +++ b/jenkins_jobs/modules/builders.py @@ -212,7 +212,7 @@ def ant(parser, xml_parent, data): :arg str buildfile: the path to the ANT build file. :arg list properties: Passed to ant script using -Dkey=value (optional) :arg str ant-name: the name of the ant installation, - defaults to 'default' (optional) + (default 'default') (optional) :arg str java-opts: java options for ant, can have multiples, must be in quotes (optional) @@ -519,9 +519,9 @@ def msbuild(parser, xml_parent, data): :arg str solution-file: location of the solution file to build :arg str extra-parameters: extra parameters to pass to msbuild (optional) :arg bool pass-build-variables: should build variables be passed - to msbuild (defaults to true) + to msbuild (default true) :arg bool continue-on-build-failure: should the build continue if - msbuild returns an error (defaults to false) + msbuild returns an error (default false) Example: @@ -727,9 +727,9 @@ def maven_target(parser, xml_parent, data): :arg str goals: Goals to execute :arg str properties: Properties for maven, can have multiples - :arg str pom: Location of pom.xml (defaults to pom.xml) + :arg str pom: Location of pom.xml (default 'pom.xml') :arg bool private-repository: Use private maven repository for this - job (defaults to false) + job (default false) :arg str maven-version: Installation of maven which should be used (optional) :arg str java-opts: java options for maven, can have multiples, diff --git a/jenkins_jobs/modules/parameters.py b/jenkins_jobs/modules/parameters.py index 8048dfd93..b3d86a1eb 100644 --- a/jenkins_jobs/modules/parameters.py +++ b/jenkins_jobs/modules/parameters.py @@ -272,10 +272,10 @@ def dynamic_choice_param(parser, xml_parent, data): :arg str description: a description of the parameter (optional) :arg str script: Groovy expression which generates the potential choices. :arg bool remote: the script will be executed on the slave where the build - is started (default is false) + is started (default false) :arg str classpath: class path for script (optional) :arg bool read-only: user can't modify parameter once populated - (default is false) + (default false) Example:: @@ -301,10 +301,10 @@ def dynamic_string_param(parser, xml_parent, data): :arg str description: a description of the parameter (optional) :arg str script: Groovy expression which generates the potential choices :arg bool remote: the script will be executed on the slave where the build - is started (default is false) + is started (default false) :arg str classpath: class path for script (optional) :arg bool read-only: user can't modify parameter once populated - (default is false) + (default false) Example:: @@ -334,9 +334,9 @@ def dynamic_choice_scriptler_param(parser, xml_parent, data): :Parameter: * **name** (`str`) Parameter name * **value** (`str`) Parameter value :arg bool remote: the script will be executed on the slave where the build - is started (default is false) + is started (default false) :arg bool read-only: user can't modify parameter once populated - (default is false) + (default false) Example:: @@ -372,9 +372,9 @@ def dynamic_string_scriptler_param(parser, xml_parent, data): :Parameter: * **name** (`str`) Parameter name * **value** (`str`) Parameter value :arg bool remote: the script will be executed on the slave where the build - is started (default is false) + is started (default false) :arg bool read-only: user can't modify parameter once populated - (default is false) + (default false) Example:: diff --git a/jenkins_jobs/modules/project_maven.py b/jenkins_jobs/modules/project_maven.py index 138f16fac..e463eb9ee 100755 --- a/jenkins_jobs/modules/project_maven.py +++ b/jenkins_jobs/modules/project_maven.py @@ -24,7 +24,7 @@ in the :ref:`Job` definition. * **root-module**: * **group-id** (`str`): GroupId. * **artifact-id** (`str`): ArtifactId. - * **root-pom** (`str`): The path to the pom.xml file. (defaults to pom.xml) + * **root-pom** (`str`): The path to the pom.xml file. (default 'pom.xml') * **goals** (`str`): Goals to execute. (required) * **maven-opts** (`str`): Java options to pass to maven (aka MAVEN_OPTS) * **maven-name** (`str`): Installation of maven which should be used. @@ -34,9 +34,9 @@ in the :ref:`Job` definition. Possible values are `default`, `local-to-workspace` and `local-to-executor`. * **ignore-upstream-changes** (`bool`): Do not start a build whenever - a SNAPSHOT dependency is built or not. (defaults to true) + a SNAPSHOT dependency is built or not. (default true) * **automatic-archiving** (`bool`): Activate automatic artifact archiving - (defaults to true). + (default true). * **settings** (`str`): Path to custom maven settings file (optional) * **global-settings** (`str`): Path to custom maven global settings file (optional) diff --git a/jenkins_jobs/modules/properties.py b/jenkins_jobs/modules/properties.py index 04ce3bb46..ee465167b 100644 --- a/jenkins_jobs/modules/properties.py +++ b/jenkins_jobs/modules/properties.py @@ -449,7 +449,7 @@ def build_blocker(parser, xml_parent, data): `_ :arg bool use-build-blocker: Enable or disable build blocker - (optional, defaults to True) + (optional) (default true) :arg list blocking-jobs: One regular expression per line to select blocking jobs by their names. (required) @@ -551,7 +551,7 @@ def heavy_job(parser, xml_parent, data): `_ :arg int weight: Specify the total number of executors - that this job should occupy (defaults to 1) + that this job should occupy (default 1) Example: diff --git a/jenkins_jobs/modules/publishers.py b/jenkins_jobs/modules/publishers.py index a94ae0c3e..bc7a3bf46 100644 --- a/jenkins_jobs/modules/publishers.py +++ b/jenkins_jobs/modules/publishers.py @@ -737,15 +737,14 @@ def ftp(parser, xml_parent, data): :arg str site: name of the ftp site :arg str target: destination directory :arg bool target-is-date-format: whether target is a date format. If true, - raw text should be quoted (defaults to False) + raw text should be quoted (default false) :arg bool clean-remote: should the remote directory be deleted before - transferring files (defaults to False) + transferring files (default false) :arg str source: source path specifier :arg str excludes: excluded file pattern (optional) :arg str remove-prefix: prefix to remove from uploaded file paths (optional) - :arg bool fail-on-error: fail the build if an error occurs (defaults to - False). + :arg bool fail-on-error: fail the build if an error occurs (default false). Example:: @@ -1179,20 +1178,19 @@ def ssh(parser, xml_parent, data): :arg str site: name of the ssh site :arg str target: destination directory :arg bool target-is-date-format: whether target is a date format. If true, - raw text should be quoted (defaults to False) + raw text should be quoted (default false) :arg bool clean-remote: should the remote directory be deleted before - transferring files (defaults to False) + transferring files (default false) :arg str source: source path specifier :arg str command: a command to execute on the remote server (optional) :arg int timeout: timeout in milliseconds for the Exec command (optional) - :arg bool use-pty: run the exec command in pseudo TTY (defaults to False) + :arg bool use-pty: run the exec command in pseudo TTY (default false) :arg str excludes: excluded file pattern (optional) :arg str remove-prefix: prefix to remove from uploaded file paths (optional) - :arg bool fail-on-error: fail the build if an error occurs (defaults to - False). + :arg bool fail-on-error: fail the build if an error occurs (default false). :arg bool always-publish-from-master: transfer the files through the master - before being sent to the remote server (defaults to False) + before being sent to the remote server (defaults false) Example:: @@ -1348,7 +1346,7 @@ def email_ext(parser, xml_parent, data): :arg str recipients: Comma separated list of emails :arg str reply-to: Comma separated list of emails that should be in - the Reply-To header for this project (default is $DEFAULT_RECIPIENTS) + the Reply-To header for this project (default $DEFAULT_RECIPIENTS) :arg str content-type: The content type of the emails sent. If not set, the Jenkins plugin uses the value set on the main configuration page. Possible values: 'html', 'text' or 'default' (default 'default') @@ -1474,7 +1472,7 @@ def fingerprint(parser, xml_parent, data): Fingerprint files to track them across builds :arg str files: files to fingerprint, follows the @includes of Ant fileset - (default is blank) + (default blank) :arg bool record-artifacts: fingerprint all archived artifacts (default false) @@ -1745,15 +1743,14 @@ def cifs(parser, xml_parent, data): :arg str site: name of the cifs site/share :arg str target: destination directory :arg bool target-is-date-format: whether target is a date format. If true, - raw text should be quoted (defaults to False) + raw text should be quoted (default false) :arg bool clean-remote: should the remote directory be deleted before - transferring files (defaults to False) + transferring files (default false) :arg str source: source path specifier :arg str excludes: excluded file pattern (optional) :arg str remove-prefix: prefix to remove from uploaded file paths (optional) - :arg bool fail-on-error: fail the build if an error occurs (defaults to - False). + :arg bool fail-on-error: fail the build if an error occurs (default false). Example:: diff --git a/jenkins_jobs/modules/triggers.py b/jenkins_jobs/modules/triggers.py index 32f3d7d07..35b6d3a33 100644 --- a/jenkins_jobs/modules/triggers.py +++ b/jenkins_jobs/modules/triggers.py @@ -160,7 +160,7 @@ def gerrit(parser, xml_parent, data): (optional) :Branch: * **branch-compare-type** (`str`) -- ''PLAIN'', - ''ANT'' or ''REG_EXP'' (optional, defaults to + ''ANT'' or ''REG_EXP'' (optional) (default ''PLAIN'') * **branch-pattern** (`str`) -- Branch name pattern to match @@ -169,8 +169,7 @@ def gerrit(parser, xml_parent, data): (optional) :File Path: * **compare-type** (`str`) -- ''PLAIN'', ''ANT'' - or ''REG_EXP'' (optional, defaults to - ''PLAIN'') + or ''REG_EXP'' (optional) (default ''PLAIN'') * **pattern** (`str`) -- File path pattern to match diff --git a/jenkins_jobs/modules/wrappers.py b/jenkins_jobs/modules/wrappers.py index 0272744d7..fa4c20aef 100644 --- a/jenkins_jobs/modules/wrappers.py +++ b/jenkins_jobs/modules/wrappers.py @@ -611,7 +611,7 @@ def release(parser, xml_parent, data): Requires the Jenkins `Release Plugin. `_ - :arg bool keep-forever: Keep build forever (default is 'true') + :arg bool keep-forever: Keep build forever (default true) :arg bool override-build-parameters: Enable build-parameter override :arg string version-template: Release version template :arg list parameters: Release parameters (see the :ref:`Parameters` module)