Re: [LTP] Reg: Script to extract description of test case from LTPROOT/doc/testcases/*.txt files

[Subrata Modak <subrata@linux.vnet.ibm.com>]

On Fri, 2009-06-19 at 12:00 +0530, rohit verma wrote: 
> Hi all,
> 
> PFA the patch which formats the LTP documentation in 'ltp/doc/testcases' folder.
> 
> Note: The formatting is applied to only kernel, misc, network and
> commands test-cases.
> 
> Formatting used is based on my ideas and comments from Subrata.
> Comments on the same are welcome.
> 
> 
> Regards,
> Rohit

Thanks.

Regards--
Subrata

> 
> 
> 
> On Thu, Jun 18, 2009 at 11:01 PM, Subrata
> Modak<subrata@linux.vnet.ibm.com> wrote:
> > Hi,
> >
> > I think this is good to start with. Send them to LTP mailing list as a
> > patch.
> >
> > Regards--
> > Subrata
> >
> > On Mon, 2009-06-15 at 14:11 +0530, rohit verma wrote:
> >> Hi,
> >>
> >> PFA the formatted documentation for network,kernel,misc and command
> >> test-cases. I have verified the document with the original one. Both
> >> data match except for the formatting pretty much. However, if u notice
> >> any inconsistency, do let me know.
> >>
> >> Regards,
> >> Rohit
> >>
> >> On Thu, Jun 4, 2009 at 4:12 PM, Subrata Modak<subrata@linux.vnet.ibm.com> wrote:
> >> > On Thu, 2009-06-04 at 15:42 +0530, rohit verma wrote:
> >> >> Hi,
> >> >>
> >> >> Yes. I am writing a script that can do the formatting job.
> >> >>
> >> >> Following is the format that I have used:
> >> >>
> >> >> <testname=stress_cd>
> >> >>  <description>
> >> >>   Creates multiple read threads on the cdrom device.
> >> >>  <\description>
> >> >>  <test_location>
> >> >>   ./testcases/kernel/io/stress_cd/stress_cd.c
> >> >>  <\test_location>
> >> >> <\testname>
> >> >>
> >> >> Is there any way i can find out the full path of the test-case, other
> >> >> than using 'find' command?
> >> >>
> >> >
> >> > Go out of ltp-* directory, and then do find.
> >> >
> >> > So, you will get:
> >> > ./ltp/testcases/kernel/io/stress_cd/stress_cd.c
> >> >
> >> > Then do find-&-replace of
> >> > ./ltp
> >> > with
> >> > ltp
> >> >
> >> >> Let me know if the format is fine.
> >> >>
> >> >
> >> > OK.
> >> >
> >> > Regards--
> >> > Subrata
> >> >
> >> >> Regards,
> >> >> Rohit
> >> >>
> >> >>
> >> >> On Thu, Jun 4, 2009 at 2:57 PM, Subrata Modak
> >> >> <subrata@linux.vnet.ibm.com> wrote:
> >> >> > On Wed, 2009-05-27 at 19:53 +0530, Subrata Modak wrote:
> >> >> >> On Wed, 2009-05-27 at 00:18 -0700, rohit verma wrote:
> >> >> >> > Hi Subrata,
> >> >> >> >
> >> >> >> > As the purpose of this document is to brief the description of each
> >> >> >> > test case to user. I feel that your format would decrease the
> >> >> >> > readability in document .
> >> >> >> >
> >> >> >> > So should we include following tags   "test_location",
> >> >> >> > "test_cmdfile_name", "test_cmdfile_entry",
> >> >> >> > "Execute_through_commandline", "Execute_through_runltp". or only
> >> >> >> > description tag would be sufficient.
> >> >> >>
> >> >> >> Fine then, but i would insist you to include "testname" &
> >> >> >> "test_location" apart from "test_description".
> >> >> >
> >> >> > Rohit,
> >> >> >
> >> >> > Are you working on this ?
> >> >> >
> >> >> > Regards--
> >> >> > Subrata
> >> >> >
> >> >> >>
> >> >> >> Regards--
> >> >> >> Subrata
> >> >> >>
> >> >> >> >
> >> >> >> > Regards,
> >> >> >> > rohit
> >> >> >> >
> >> >> >> >
> >> >> >> > On Tue, May 26, 2009 at 5:22 AM, Subrata Modak
> >> >> >> > <subrata@linux.vnet.ibm.com> wrote:
> >> >> >> > > On Mon, 2009-05-25 at 21:40 -0700, rohit verma wrote:
> >> >> >> > >> Hi Subrata,
> >> >> >> > >>
> >> >> >> > >> I request you to finalize the format of the documentation ASAP.
> >> >> >> > >
> >> >> >> > > I would like to see something like:
> >> >> >> > >
> >> >> >> > > <testname=abort(3)>
> >> >> >> > >  <test_description="Basic test for abort(3)">
> >> >> >> > >  <\test_description>
> >> >> >> > >  <test_location="ltp/testcases/kernel/syscalls/abort/abort01.c">
> >> >> >> > >  <\test_location>
> >> >> >> > >  <test_cmdfile_name="ltp/runtest/syscalls">
> >> >> >> > >  <\test_cmdfile_name>
> >> >> >> > >  <test_cmdfile_entry="abort01 ulimit -c 1024;abort01">
> >> >> >> > >  <\test_cmdfile_entry>
> >> >> >> > >  <Execute_through_commandline="ulimit -c
> >> >> >> > > 1024; ./ltp/testcases/bin/abort01">
> >> >> >> > >  <\Execute_through_commandline>
> >> >> >> > >  <Execute_through_runltp="./runltp -s abort01">
> >> >> >> > >  <\Execute_through_runltp>
> >> >> >> > > <\testname>
> >> >> >> > >
> >> >> >> > > The basic idea is to include all important information as we can when we
> >> >> >> > > are doing some patching on this. Let me know how others feel, and how we
> >> >> >> > > can achieve this.
> >> >> >> > >
> >> >> >> > > Regards--
> >> >> >> > > Subrata
> >> >> >> > >
> >> >> >> > >>
> >> >> >> > >> Ltp-list : Please provide the inputs regarding the text documentation format.
> >> >> >> > >>
> >> >> >> > >> Regards,
> >> >> >> > >> rohit
> >> >> >> > >>
> >> >> >> > >> On Tue, May 19, 2009 at 3:31 AM, Subrata Modak
> >> >> >> > >> <subrata@linux.vnet.ibm.com> wrote:
> >> >> >> > >> > Hi Rohit,
> >> >> >> > >> >
> >> >> >> > >> > On Mon, 2009-05-18 at 19:21 +0800, CAI Qian wrote:
> >> >> >> > >> >> From: rohit verma <rohit.170309@gmail.com>
> >> >> >> > >> >> Subject: Re: Reg: Script to extract description of test case from LTPROOT/doc/testcases/*.txt files
> >> >> >> > >> >> Date: Mon, 18 May 2009 04:55:54 -0700
> >> >> >> > >> >>
> >> >> >> > >> >> > Dear Subrata/Qian,
> >> >> >> > >> >> >
> >> >> >> > >> >> > I am trying to develop script which would extracts description information
> >> >> >> > >> >> > about user required test case from LTPROOT/doc/testcases/ folder.
> >> >> >> > >> >> >
> >> >> >> > >> >> > So to make the description text file  as standard file, can we represent the
> >> >> >> > >> >> > description as mentioned below.
> >> >> >> > >> >> >
> >> >> >> > >> >> > For example in syscalls category:
> >> >> >> > >> >> >
> >> >> >> > >> >> > Currently available format of description in LTP as follows.
> >> >> >> > >> >> >
> >> >> >> > >> >> >   abort01
> >> >> >> > >> >> >    Basic test for abort(3).
> >> >> >> > >> >> >
> >> >> >> > >> >> >   accept01
> >> >> >> > >> >> >    Verify that accept() returns the proper errno for various failure cases
> >> >> >> > >> >> >
> >> >> >> > >> >> >
> >> >> >> > >> >> > To make it in consistent way, description should be enclosed by executables
> >> >> >> > >> >> > as follows.
> >> >> >> > >> >> >
> >> >> >> > >> >> >  <abort01>
> >> >> >> > >> >> >    Basic test for abort(3).
> >> >> >> > >> >> >  <\abort01>
> >> >> >> > >> >> >
> >> >> >> > >> >> >  <accept01>
> >> >> >> > >> >> >    Verify that accept() returns the proper errno for various failure cases
> >> >> >> > >> >> >  <\accept01>
> >> >> >> > >> >> >
> >> >> >> > >> >> > Please confirm if this format is O.K or suggest any other format by which we
> >> >> >> > >> >> > can easily parse the test cases and extracts the description.
> >> >> >> > >> >
> >> >> >> > >> > Itś always great to see somebody working on LTP documentation. So, lets
> >> >> >> > >> > ask the community also for their opinion as well. Can we also include
> >> >> >> > >> > some more tags for more descriptive info ?
> >> >> >> > >> >
> >> >> >> > >> > Regards--
> >> >> >> > >> > Subrata
> >> >> >> > >> >
> >> >> >> > >> >> >
> >> >> >> > >> >>
> >> >> >> > >> >> Looks good for me.
> >> >> >> > >> >>
> >> >> >> > >> >> CAI Qian
> >> >> >> > >> >>
> >> >> >> > >> >> > If this format is O.K , I would send the patch for those text files
> >> >> >> > >> >> >
> >> >> >> > >> >> > Regards,
> >> >> >> > >> >> > Rohit
> >> >> >> > >> >> >
> >> >> >> > >> >> >
> >> >> >> > >> >> >
> >> >> >> > >> >> > On Wed, May 13, 2009 at 7:55 AM, CAI Qian <caiqian@cclom.cn> wrote:
> >> >> >> > >> >> >
> >> >> >> > >> >> >> From: rohit verma <rohit.170309@gmail.com>
> >> >> >> > >> >> >> Subject: Reg: Script to extract description of test case from
> >> >> >> > >> >> >> LTPROOT/doc/testcases/*.txt files
> >> >> >> > >> >> >> Date: Wed, 13 May 2009 02:16:57 -0700
> >> >> >> > >> >> >>
> >> >> >> > >> >> >> > Dear Subrata/qian,
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> > As if we run LTP testcases, nowhere LTP test suite populates the
> >> >> >> > >> >> >> > description of testcases (either in .log, .output, .HTML or .failed
> >> >> >> > >> >> >> > test cases files).
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> > Description of each test case in category wise is available in
> >> >> >> > >> >> >> > LTPROOT/doc/testcases folder.
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> > My Question : Is there any ready-made script available to extract the
> >> >> >> > >> >> >> > description of user required test case from above specified folder?
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> > If script is not available, could you suggest the direction to extract
> >> >> >> > >> >> >> > description of test cases.
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> >
> >> >> >> > >> >> >> > Regards,
> >> >> >> > >> >> >> > Rohit.
> >> >> >> > >> >> >>
> >> >> >> > >> >> >> Not I am aware of. Subrata or someone in the list might have some ideas
> >> >> >> > >> >> >> for you.
> >> >> >> > >> >> >>
> >> >> >> > >> >> >> CAI Qian
> >> >> >> > >> >> >>
> >> >> >> > >> >
> >> >> >> > >> >
> >> >> >> > >
> >> >> >> > >
> >> >> >>
> >> >> >>
> >> >> >> ------------------------------------------------------------------------------
> >> >> >> Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT
> >> >> >> is a gathering of tech-side developers & brand creativity professionals. Meet
> >> >> >> the minds behind Google Creative Lab, Visual Complexity, Processing, &
> >> >> >> iPhoneDevCamp as they present alongside digital heavyweights like Barbarian
> >> >> >> Group, R/GA, & Big Spaceship. http://p.sf.net/sfu/creativitycat-com
> >> >> >> _______________________________________________
> >> >> >> Ltp-list mailing list
> >> >> >> Ltp-list@lists.sourceforge.net
> >> >> >> https://lists.sourceforge.net/lists/listinfo/ltp-list
> >> >> >
> >> >> >
> >> >
> >> >
> >
> >


------------------------------------------------------------------------------
Are you an open source citizen? Join us for the Open Source Bridge conference!
Portland, OR, June 17-19. Two days of sessions, one day of unconference: $250.
Need another reason to go? 24-hour hacker lounge. Register today!
http://ad.doubleclick.net/clk;215844324;13503038;v?http://opensourcebridge.org
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list