[Lldb-commits] [lldb] r296693 - Make it clear what you should modify when you copy any of these sample

[Jim Ingham via lldb-commits]

Author: jingham
Date: Wed Mar  1 16:23:30 2017
New Revision: 296693

URL: http://llvm.org/viewvc/llvm-project?rev=296693&view=rev
Log:
Make it clear what you should modify when you copy any of these sample
test cases.

Modified:
    lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleInlineTest.py
    lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py

Modified: lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleInlineTest.py
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleInlineTest.py?rev=296693&r1=296692&r2=296693&view=diff
==============================================================================
--- lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleInlineTest.py (original)
+++ lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleInlineTest.py Wed Mar  1 16:23:30 2017
@@ -1,3 +1,7 @@
+"""
+Describe the purpose of the test here.
+"""
+
 from __future__ import absolute_import
 
 from lldbsuite.test import lldbinline

Modified: lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py?rev=296693&r1=296692&r2=296693&view=diff
==============================================================================
--- lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py (original)
+++ lldb/trunk/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py Wed Mar  1 16:23:30 2017
@@ -1,5 +1,5 @@
 """
-Sample test that runs a process to a source regexp breakpoint.
+Describe the purpose of the test class here.
 """
 
 from __future__ import print_function
@@ -13,14 +13,17 @@ import lldbsuite.test.lldbutil as lldbut
 from lldbsuite.test.lldbtest import *
 
 
-class SampleTestTestCase(TestBase):
+class RenameThisSampleTestTestCase(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
+    # If your test case doesn't stress debug info, the 
+    # set this to true.  That way it won't be run once for
+    # each debug info format.
     NO_DEBUG_INFO_TESTCASE = True
 
-    def test_sample(self):
-        """A sample test example that drives a debug session to a breakpoint."""
+    def test_sample_rename_this(self):
+        """There can be many tests in a test case - describe this test here."""
         self.build()
         self.sample_test()
 
@@ -29,7 +32,7 @@ class SampleTestTestCase(TestBase):
         TestBase.setUp(self)
 
     def sample_test(self):
-        """A sample test example that drives a debug session to a breakpoint."""
+        """You might use the test implementation in several ways, say so here."""
         exe = os.path.join(os.getcwd(), "a.out")
 
         # Create a target by the debugger.