Re: [LTP] [PATCH 1/2]semctl/semctl01.c: cleanup

[chrubis@suse.cz]

Hi!
> > > i don't see high level DESCRIPTION/ALGORITHM as "useless".  why do you ?
> > 
> > In my opinion, "ALGORITHM" section of many ltp testcases follows one
> > format: ------------------------------------------------
> > setup()
> > loop test frame
> > 	loop all test cases
> > 		TEST(call)
> > 		if call failed
> > 			log the errno
> > 		else
> > 			if functionality is ok
> > 				case PASS
> > 			else
> > 				case FAIL
> > cleanup()
> > ------------------------------------------------
> > 
> > So, i think this section is redundant and useless once someone has
> > learned the test frame.
> 
> and if you delete all the sections, then what are people going to refer to ?

I usually end up with less structured but IMHO more readable
description. Having the descriptions in form of pseudocode seems to be
useless as the actual code is right bellow it. I tend to rewrite these
into something like:

'Call foo with bar options and check for xyz result.'

Which shortens the description into one sentence but all the important
information is preserved.

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and 
their applications. This 200-page book is written by three acclaimed 
leaders in the field. The early access version is available now. 
Download your free book today! http://p.sf.net/sfu/neotech_d2d_may
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list