This is an automated email from the ASF dual-hosted git repository.

wkaras pushed a commit to branch block_comment
in repository https://gitbox.apache.org/repos/asf/trafficserver.git

commit 2768d955fd82e95cae511ba0cbf032f3447c68aa
Author: Walt Karas <[email protected]>
AuthorDate: Fri Mar 17 23:31:31 2023 +0000

    Improve comment on Au test extension function MakeATSProcess().
---
 tests/gold_tests/autest-site/trafficserver.test.ext | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/tests/gold_tests/autest-site/trafficserver.test.ext 
b/tests/gold_tests/autest-site/trafficserver.test.ext
index ad9b10837..10e696af7 100755
--- a/tests/gold_tests/autest-site/trafficserver.test.ext
+++ b/tests/gold_tests/autest-site/trafficserver.test.ext
@@ -47,15 +47,20 @@ default_log_data = {
     'manager': 'manager.log'
 }
 
-# 'block_for_debug', if True, causes traffic_server to run with the --block 
option enabled, and effectively
-# disables timeouts that could be triggered by running traffic_server under a 
debugger.
-
 
 def MakeATSProcess(obj, name, command='traffic_server', select_ports=True,
                    enable_tls=False, enable_cache=True, enable_quic=False,
                    block_for_debug=False, log_data=default_log_data,
                    use_traffic_out=True, dump_runroot=True,
                    enable_proxy_protocol=False):
+    """Create a traffic server process.
+
+    :param block_for_debug: if True, causes traffic_server to run with the
+    --block option enabled, and effectively disables timeouts that could be
+    triggered by running traffic_server under a debugger. In the debugger,
+    `set cmd_block = 0`, set any desired break points, then `c` to continue
+    to let the test proceed.
+    """
     #####################################
     # common locations
 

Reply via email to