Simplifying repro instructions from bisect output for non telemetry cases.

tools/bisect-perf-regression.py

 #!/usr/bin/env python
 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Performance Test Bisect Tool
 
 This script bisects a series of changelists using binary search. It starts at
 a bad revision where a performance metric has regressed, and asks for a last
 known-good revision. It will then binary search across this revision range by
@@ skipping 194 matching lines @@
 RESULTS_REVISION_INFO = """
 ===== SUSPECTED CL(s) =====
 Subject : %(subject)s
 Author  : %(author)s%(email_info)s%(commit_info)s
 Commit  : %(cl)s
 Date    : %(cl_date)s"""
 
 REPRO_STEPS_LOCAL = """
 ==== INSTRUCTIONS TO REPRODUCE ====
 To run locally:
-$%(command)s"""
+ - Use Test Command given under BISECT JOB RESULTS above.

[qyearsley, 2014/09/24 03:03:04]

What do you think about tweaking this a bit to 'Use the test command given under
the "BISECT JOB RESULTS" section above.' ? (no capitals for Test Command)

I'm fine with it either way, this is just a suggestion.

+ - Consider using a profiler (pass --profiler=list to list the available ones).

[qyearsley, 2014/09/24 03:03:04]

Possible suggestion: You can use a profiler; pass --profiler=list to list
available profilers."

Or, to be less verbose, we could also no mention this here; instead we could in
this section just say:

To run locally, use the test command given under BISECT JOB RESULTS above.

+"""
 
 REPRO_STEPS_TRYJOB = """
 To reproduce on a performance try bot:
-1. Create new git branch or check out existing branch.
-2. Edit tools/run-perf-test.cfg (instructions in file) or \
-third_party/WebKit/Tools/run-perf-test.cfg.
-  a) Take care to strip any src/ directories from the head of \
-relative path names.
-  b) On desktop, only --browser=release is supported, on android \
---browser=android-chromium-testshell.
-  c) Test command to use: %(command)s
-3. Upload your patch. --bypass-hooks is necessary to upload the changes you \
-committed locally to run-perf-test.cfg.
-   Note: *DO NOT* commit run-perf-test.cfg changes to the project repository.
-   $ git cl upload --bypass-hooks
-4. Send your try job to the try server. \
-[Please make sure to use appropriate bot to reproduce]
-   $ git cl try -m tryserver.chromium.perf -b <bot>
+ 1. Edit run-perf-test.cfg
+ 2. Upload your patch with: $ git cl upload --bypass-hooks
+ 3. Send to the try server: $ git cl try -m tryserver.chromium.perf -b <bot>

[qyearsley, 2014/09/24 03:03:04]

git cl upload and git cl try is actually not necessary now -- it can be done
with 'git try --svn_repo="svn://svn.chromium.org/chrome-try/try-perf" -b <bot>'

(Note, I just put my notes for this in
https://sites.google.com/a/google.com/chromeperf/auto-bisect/hacking-on-auto-...;
we could also put it somewhere else.)

+
+Notes:
+ a) Follow the in-file instructions in run-perf-test.cfg.
+ b) run-perf-test.cfg is under tools/ or under third_party/WebKit/Tools.
+ c) Do your edits preferably under a new git branch.
+ d) --browser=release and --browser=android-chromium-testshell are supported
+    depending on the platform (desktop|android).
+ e) Strip any src/ directories from the head of relative path names.
+ f) Make sure to use the appropriate bot on step 3.
 
 For more details please visit
 https://sites.google.com/a/chromium.org/dev/developers/performance-try-bots"""
 
 REPRO_STEPS_TRYJOB_TELEMETRY = """
 To reproduce on a performance try bot:
 %(command)s
 (Where <bot-name> comes from tools/perf/run_benchmark --browser=list)
 
 For more details please visit
 https://sites.google.com/a/chromium.org/dev/developers/performance-try-bots
 """
 
 RESULTS_THANKYOU = """
 ===== THANK YOU FOR CHOOSING BISECT AIRLINES =====
 Visit http://www.chromium.org/developers/core-principles for Chrome's policy
 on perf regressions.
 Contact chrome-perf-dashboard-team with any questions or suggestions about
 bisecting.
-.                   .------.
-.     .---.         \       \==)
+.                   .-----.
+.     .---.         \      \==)
 .     |PERF\         \       \\
 .     |     ---------'-------'-----------.
-.     . 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 `-.
-.     \______________.-------._______________)
+.     .     0 0 0 0 0 0 0 0 0 0 0 0 0 0 |_`-.
+.      \_____________.-------._______________)
 .                   /       /
-.                  /       /
-.                 /       /==)
-.                ._______."""
+.                  /      /
+.                 /     /==)
+.                ._____."""
 
 
 def _AddAdditionalDepotInfo(depot_info):
   """Adds additional depot info to the global depot variables."""
   global DEPOT_DEPS_NAME
   global DEPOT_NAMES
   DEPOT_DEPS_NAME = dict(DEPOT_DEPS_NAME.items() + depot_info.items())
   DEPOT_NAMES = DEPOT_DEPS_NAME.keys()
 
 
@@ skipping 1930 matching lines @@
     Returns:
       A tuple with the new bad and good revisions.
     """
     # DONOT perform nudge because at revision 291563 .DEPS.git was removed
     # and source contain only DEPS file for dependency changes.
     if good_svn_revision >= 291563:
       return (bad_revision, good_revision)
 
     if self.source_control.IsGit() and self.opts.target_platform == 'chromium':
       changes_to_deps = self.source_control.QueryFileRevisionHistory(
-          FILE_DEPS, good_revision, bad_revision)
+          bisect_utils.FILE_DEPS, good_revision, bad_revision)
 
       if changes_to_deps:
         # DEPS file was changed, search from the oldest change to DEPS file to
         # bad_revision to see if there are matching .DEPS.git changes.
         oldest_deps_change = changes_to_deps[-1]
         changes_to_gitdeps = self.source_control.QueryFileRevisionHistory(
             bisect_utils.FILE_DEPS_GIT, oldest_deps_change, bad_revision)
 
         if len(changes_to_deps) != len(changes_to_gitdeps):
           # Grab the timestamp of the last DEPS change
@@ skipping 523 matching lines @@
 
   def _PrintReproSteps(self):
     """Prints out a section of the results explaining how to run the test.
 
     This message includes the command used to run the test.
     """
     command = '$ ' + self.opts.command
     if bisect_utils.IsTelemetryCommand(self.opts.command):
       command += ('\nAlso consider passing --profiler=list to see available '
                   'profilers.')
-    print REPRO_STEPS_LOCAL % {'command': command}
+    print REPRO_STEPS_LOCAL
     if bisect_utils.IsTelemetryCommand(self.opts.command):
       telemetry_command = re.sub(r'--browser=[^\s]+',
                                  '--browser=<bot-name>',
                                  command)
       print REPRO_STEPS_TRYJOB_TELEMETRY % {'command': telemetry_command}
     else:
-      print REPRO_STEPS_TRYJOB % {'command': command}
+      print REPRO_STEPS_TRYJOB
 
   def _PrintOtherRegressions(self, other_regressions, revision_data):
     """Prints a section of the results about other potential regressions."""
     print
     print 'Other regressions may have occurred:'
     print '  %8s  %70s  %10s' % ('Depot'.center(8, ' '),
         'Range'.center(70, ' '), 'Confidence'.center(10, ' '))
     for regression in other_regressions:
       current_id, previous_id, confidence = regression
       current_data = revision_data[current_id]
@@ skipping 623 matching lines @@
       # bugs. If you change this, please update the perf dashboard as well.
       bisect_utils.OutputAnnotationStepStart('Results')
     print 'Error: %s' % e.message
     if opts.output_buildbot_annotations:
       bisect_utils.OutputAnnotationStepClosed()
   return 1
 
 
 if __name__ == '__main__':
   sys.exit(main())