Make it clear what you should modify when you copy any of these sample

test cases.

llvm-svn: 296693

1 files changed, 8 insertions, 5 deletions

diff --git a/lldb/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py b/lldb/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py
index 16f48022d9a..bb34727ff81 100644
--- a/lldb/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py
+++ b/lldb/packages/Python/lldbsuite/test/sample_test/TestSampleTest.py
@@ -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 lldbutil
 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.