Added printing of a couple of links to documentation in case warnings are rep...

tools/valgrind/valgrind_test.py

 #!/usr/bin/python
 # Copyright (c) 2006-2008 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.
 
 # valgrind_test.py
 
 '''Runs an exe through Valgrind and puts the intermediate files in a
 directory.
 '''
@@ skipping 348 matching lines @@
 
     return ret
 
   def Analyze(self):
     # Glob all the files in the "valgrind.tmp" directory
     filenames = glob.glob(self.TMP_DIR + "/memcheck.*")
 
     use_gdb = (sys.platform == 'darwin')
     analyzer = memcheck_analyze.MemcheckAnalyze(self._source_dir, filenames, self._options.show_all_leaks,
                                                 use_gdb=use_gdb)
-    return analyzer.Report()
+    ret = analyzer.Report()
+    if ret != 0:
+      logging.info("Please see http://dev.chromium.org/developers/how-tos/"
+                   "using-valgrind for the info on Memcheck/Valgrind")
+    return ret

[stuartmorgan, 2009/10/27 20:28:27]

The return value is non-zero if there are leaks or invalid reads; why do we need
to tell people how to use valgrind if it's run correctly but finds problems?

 
 class ThreadSanitizer(ValgrindTool):
   """ThreadSanitizer"""
 
   def __init__(self):
     ValgrindTool.__init__(self)
 
   def ToolName(self):
     return "tsan"
 
@@ skipping 49 matching lines @@
     if platform_suffix == 'mac':
       ret += ["--show-pc=yes"]
 
     return ret
 
   def Analyze(self):
     filenames = glob.glob(self.TMP_DIR + "/tsan.*")
     use_gdb = (sys.platform == 'darwin')
     analyzer = tsan_analyze.TsanAnalyze(self._source_dir, filenames,
                                         use_gdb=use_gdb)
-    return analyzer.Report()
+    ret = analyzer.Report()
+    if ret != 0:
+      logging.info("Please see http://dev.chromium.org/developers/how-tos/"
+                   "using-valgrind/threadsanitizer for the info on "
+                   "ThreadSanitizer")
+    return ret
 
 
 class ToolFactory:
   def Create(self, tool_name):
     if tool_name == "memcheck":
       return Memcheck()
     if tool_name == "tsan":
       if sys.platform != 'linux2':
-        logging.info("WARNING: ThreadSanitizer is not working yet on Mac")
+        logging.info("WARNING: ThreadSanitizer may be unstable on Mac.")
+        logging.info("See http://code.google.com/p/data-race-test/wiki/"
+                     "ThreadSanitizerOnMacOsx for the details")
       return ThreadSanitizer()
     raise RuntimeError, "Unknown tool" \
                         "(tool=%s, platform=%s)" % \
                         (tool_name, sys.platform)
 
 def RunTool(argv):
   # TODO(timurrrr): customize optparse instead
   tool_name = "memcheck"
   args = argv[1:]
   for arg in args:
     if arg.startswith("--tool="):
       tool_name = arg[7:]
       args.remove(arg)
       break
 
   tool = ToolFactory().Create(tool_name)
   return tool.Main(args)
 
 if __name__ == "__main__":
   if sys.argv.count("-v") > 0 or sys.argv.count("--verbose") > 0:
     google.logging_utils.config_root(logging.DEBUG)
   else:
     google.logging_utils.config_root()
   # TODO(timurrrr): valgrind tools may use -v/--verbose as well
 
   ret = RunTool(sys.argv)
   sys.exit(ret)