pyln-testing: improve description of wait_for_logs

This commit is contained in:
Simon Vrouwe 2021-12-14 13:47:50 +02:00 committed by Rusty Russell
parent 84bead9396
commit ad22535d34

View file

@ -277,9 +277,12 @@ class TailableProc(object):
def wait_for_logs(self, regexs, timeout=TIMEOUT): def wait_for_logs(self, regexs, timeout=TIMEOUT):
"""Look for `regexs` in the logs. """Look for `regexs` in the logs.
We tail the stdout of the process and look for each regex in `regexs`, The logs contain tailed stdout of the process. We look for each regex
starting from last of the previous waited-for log entries (if any). We in `regexs`, starting from `logsearch_start` which normally is the
fail if the timeout is exceeded or if the underlying process position of the last found entry of a previous wait-for logs call.
The ordering inside `regexs` doesn't matter.
We fail if the timeout is exceeded or if the underlying process
exits before all the `regexs` were found. exits before all the `regexs` were found.
If timeout is None, no time-out is applied. If timeout is None, no time-out is applied.