Re: [LTP] LTP Documentation

[Subrata M. <su...@li...>]

Hi Praveen,

On Sat, 2009-06-27 at 13:07 +0530, Praveen wrote: 
>  
> 
> Hi Subrata,
> 
>  
> 
> Thanks for the information.
> 
>  
> 
> I have few doubts regarding the LTP documentation:
> 
> ·        Description field already describes of ‘what exactly this
> test case is doing’ (Should I have 
> 
> to detail it more?)

Yes, if you think that is not sufficient. Add as much documentation you
can there also. Sf.net does not have any restriction(s) in the size of
source code we can have. And more the documentation clarity, better is
the test case usage.

> 
> ·        If I need to add information (description of test), where
> should I add it – I mean 

Here itself you can add. That is the first thing to do. When you have
completed visiting all test cases(would take very-very-long time to
complete), you can visit code sniffets, and then add documentation per
code line later.

Regards--
Subrata

> 
> should I create another filed for that or update the same
> ‘description’ field?
> 
>  
> 
>  
> 
> Snippet from LTP Test case:
> 
>  
> 
> #
> 
> # File :        cp_test.sh
> 
> #
> 
> # Description:  Test basic functionality of cp command
> 
> #               - Test #1:  cp -R can do a recursive copy
> 
> #
> 
> # Author:       Manoj Iyer, ma...@ma...
> 
> #
> 
> # History:      Jan 30 2003 - Created - Manoj Iyer.
> 
> #               Feb 03 2003 - Fixed expected outpu
> 
>  
> 
>  
> 
> Thanks,
> 
> Praveen Kumar k
> 
>  
> 
>