From mboxrd@z Thu Jan 1 00:00:00 1970 From: Petr Vorel Date: Mon, 21 Oct 2019 15:15:30 +0200 Subject: [LTP] [PATCH v4 5/5] Adopt doc for TST_RETRY_FUNC for LTP_TIMEOUT_MUL In-Reply-To: <87h842o2pp.fsf@rpws.prws.suse.cz> References: <20191018124502.25599-1-cfamullaconrad@suse.de> <20191018124502.25599-6-cfamullaconrad@suse.de> <87h842o2pp.fsf@rpws.prws.suse.cz> Message-ID: <20191021131530.GB18513@x230> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: ltp@lists.linux.it Hi, > Clemens Famulla-Conrad writes: > > Mention that time limit is mulitplied with LTP_TIMEOUT_MUL. > > --- > > doc/test-writing-guidelines.txt | 3 ++- > > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/doc/test-writing-guidelines.txt b/doc/test-writing-guidelines.txt > > index efff4d40c..905a4baa5 100644 > > --- a/doc/test-writing-guidelines.txt > > +++ b/doc/test-writing-guidelines.txt > > @@ -2313,7 +2313,8 @@ Retry a function in limited time > > Sometimes LTP test needs retrying a function for many times to get success. > > This achievement makes that possible via keeping it retrying if the return > > value of the function is NOT as we expected. After exceeding a limited time, > > -test will break from the retries immediately. > > +test will break from the retries immediately. The time limit is multiplied > > +with LTP_TIMEOUT_MUL. > I think the function tst_multiply_timeout also needs documenting. Isn't it meant to be used just in library (in lib/tst_test.c)? Thus I wouldn't document it here. And in fact remove it from include/tst_test.h (second commit). Kind regards, Petr