summaryrefslogtreecommitdiffstats
path: root/tools/auto_bisect
diff options
context:
space:
mode:
authorqyearsley <qyearsley@chromium.org>2014-08-23 14:19:14 -0700
committerCommit bot <commit-bot@chromium.org>2014-08-23 21:20:46 +0000
commit8b8d567a9cc859db16a93330b9ac42e0439490c0 (patch)
tree2c368acbb490db63e8a95fea06a46a800e6096c4 /tools/auto_bisect
parent0d93885678215de0d9104ed1fc7ef9b5a743c563 (diff)
downloadchromium_src-8b8d567a9cc859db16a93330b9ac42e0439490c0.zip
chromium_src-8b8d567a9cc859db16a93330b9ac42e0439490c0.tar.gz
chromium_src-8b8d567a9cc859db16a93330b9ac42e0439490c0.tar.bz2
Quick spelling clean-up in the auto-bisect code.
Note: I prefer "try server" and "try bot" more than "tryserver" and "trybot" because that's what's used in the official documentation: http://dev.chromium.org/developers/testing/try-server-usage BUG= Review URL: https://codereview.chromium.org/468633005 Cr-Commit-Position: refs/heads/master@{#291579}
Diffstat (limited to 'tools/auto_bisect')
-rw-r--r--tools/auto_bisect/bisect_utils.py10
-rw-r--r--tools/auto_bisect/math_utils.py2
-rw-r--r--tools/auto_bisect/source_control.py13
3 files changed, 13 insertions, 12 deletions
diff --git a/tools/auto_bisect/bisect_utils.py b/tools/auto_bisect/bisect_utils.py
index 5e80d51..226df7b 100644
--- a/tools/auto_bisect/bisect_utils.py
+++ b/tools/auto_bisect/bisect_utils.py
@@ -85,7 +85,7 @@ REPO_PARAMS = [
def OutputAnnotationStepStart(name):
- """Outputs annotation to signal the start of a step to a trybot.
+ """Outputs annotation to signal the start of a step to a try bot.
Args:
name: The name of the step.
@@ -99,7 +99,7 @@ def OutputAnnotationStepStart(name):
def OutputAnnotationStepClosed():
- """Outputs annotation to signal the closing of a step to a trybot."""
+ """Outputs annotation to signal the closing of a step to a try bot."""
print
print '@@@STEP_CLOSED@@@'
print
@@ -111,7 +111,7 @@ def OutputAnnotationStepLink(label, url):
Args:
label: The name to print.
- url: The url to print.
+ url: The URL to print.
"""
print
print '@@@STEP_LINK@%s@%s@@@' % (label, url)
@@ -172,10 +172,10 @@ def _CreateAndChangeToSourceDirectory(working_directory):
def _SubprocessCall(cmd, cwd=None):
- """Runs a subprocess with specified parameters.
+ """Runs a command in a subprocess.
Args:
- params: A list of parameters to pass to gclient.
+ cmd: The command to run.
cwd: Working directory to run from.
Returns:
diff --git a/tools/auto_bisect/math_utils.py b/tools/auto_bisect/math_utils.py
index c225bdd..ffdcdcc 100644
--- a/tools/auto_bisect/math_utils.py
+++ b/tools/auto_bisect/math_utils.py
@@ -16,7 +16,7 @@ def TruncatedMean(data_set, truncate_percent):
Args:
data_set: Non-empty list of values.
- truncate_percent: The % from the upper and lower portions of the data set
+ truncate_percent: How much of the upper and lower portions of the data set
to discard, expressed as a value in [0, 1].
Returns:
diff --git a/tools/auto_bisect/source_control.py b/tools/auto_bisect/source_control.py
index 66b7e73..ea6bde8 100644
--- a/tools/auto_bisect/source_control.py
+++ b/tools/auto_bisect/source_control.py
@@ -36,10 +36,10 @@ class SourceControl(object):
def SyncToRevisionWithGClient(self, revision):
"""Uses gclient to sync to the specified revision.
- ie. gclient sync --revision <revision>
+ This is like running gclient sync --revision <revision>.
Args:
- revision: The git SHA1 or svn CL (depending on workflow).
+ revision: A git SHA1 hash or SVN revision number (depending on workflow).
Returns:
The return code of the call.
@@ -48,11 +48,11 @@ class SourceControl(object):
'--delete_unversioned_trees', '--nohooks', '--revision', revision])
def SyncToRevisionWithRepo(self, timestamp):
- """Uses repo to sync all the underlying git depots to the specified
- time.
+ """Uses the repo command to sync all the underlying git depots to the
+ specified time.
Args:
- timestamp: The unix timestamp to sync to.
+ timestamp: The Unix timestamp to sync to.
Returns:
The return code of the call.
@@ -227,6 +227,7 @@ class GitSourceControl(SourceControl):
Args:
revision: Revision you want to gather information on.
+
Returns:
A dict in the following format:
{
@@ -259,7 +260,7 @@ class GitSourceControl(SourceControl):
['checkout', revision, file_name], cwd=cwd)[1]
def RevertFileToHead(self, file_name):
- """Unstages a file and returns it to HEAD.
+ """Un-stages a file and resets the file's state to HEAD.
Returns:
True if successful.