From 4f4f0f57721d854aaddec8ab7dbc8759075717b5 Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Mon, 14 Apr 2014 09:53:02 -0400 Subject: [PATCH] Improved language about git revisions a bit based on review feeback. --- doc/api/methods/jobs.html.textile.liquid | 6 +++--- doc/api/schema/Job.html.textile.liquid | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/methods/jobs.html.textile.liquid b/doc/api/methods/jobs.html.textile.liquid index 66d2c084ba..351a77792f 100644 --- a/doc/api/methods/jobs.html.textile.liquid +++ b/doc/api/methods/jobs.html.textile.liquid @@ -36,11 +36,11 @@ Attributes of 'job' parameter: table(table table-bordered table-condensed). |_. Attribute |_. Type|_. Accepted values |_. Description| {background:#ccffcc}.|script |string |filename |The actual script that will be run by crunch. Must be the name of an executable file in the crunch_scripts/ directory at the git revision specified by script_version.| -{background:#ccffcc}.|script_version |string |git branch, tag, or version hash |The code version to run, which is available in the specified repository. May be a git hash or tag to specify an exact version, or a branch. If it is a branch, use the branch head.| +{background:#ccffcc}.|script_version |string |git branch, tag, or commit hash |The version of code to run, which must be available in the specified repository.| {background:#ccffcc}.|repository |string |name of git repository hosted by Arvados |The repository to search for script_version.| {background:#ccffcc}.|script_parameters |object |any JSON object |The input parameters for the job, with the parameter names as keys mapping to parameter values.| -|minimum_script_version |string |git branch, tag, or version hash |The minimum acceptable script version when deciding whether to re-use a past job.| -|exclude_script_versions|array of strings|git branch, tag, or version hash|Script versions to exclude when deciding whether to re-use a past job.| +|minimum_script_version |string |git branch, tag, or commit hash |The minimum acceptable script version (earliest ancestor) to consider when deciding whether to re-use a past job.| +|exclude_script_versions|array of strings|git branch, tag, or commit hash|Script versions to exclude when deciding whether to re-use a past job.| |nondeterministic |boolean | |If true, never re-use a past job, and flag this job so it will never be considered for re-use.| |no_reuse |boolean | |If true, do not re-use a past job, but this job may be re-used.| diff --git a/doc/api/schema/Job.html.textile.liquid b/doc/api/schema/Job.html.textile.liquid index f5d0eff919..55fb234580 100644 --- a/doc/api/schema/Job.html.textile.liquid +++ b/doc/api/schema/Job.html.textile.liquid @@ -44,7 +44,7 @@ table(table table-bordered table-condensed). |runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.| |script|string|Name of crunch script in @/crunch_scripts/@|| |script_parameters{}|list|Parameters passed to MapReduce script|| -|script_version|string|The git ref of the the git commit used to run the job.| When the job starts, Arvados updates this field to the precise git commit hash used by the job.| +|script_version|string|git branch, tag, or commit hash.|Before the job starts, this is the git branch, tag, or hash supplied by the user. When the job starts, Arvados updates this field to the full 40-character git hash of the actual commit used by the job.| |repository |string |The repository from which the script_version will be fetched.| |cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled| |cancelled_by_user_uuid|string|Authenticated user ID|Is null if job has not been cancelled| -- 2.30.2