On Tue, 2008-09-16 at 19:24 +0530, Chirag Jog wrote:
> This patch removes outdated (or irrelevant) parts of the
> existing documentation and updates its.

Hi Chirag, 

Thanks for jumping on this.  Couple nits below.

> 
> Signed-Off-By: Chirag <[EMAIL PROTECTED]>
> 
> 
>  README              |   33 +++++++++++++++------------------
>  doc/HOWTO_ADD_TESTS |   10 +++++-----
>  2 files changed, 20 insertions(+), 23 deletions(-)
> 
> 
> 
> diff --git a/testcases/realtime/README b/testcases/realtime/README
> index 32a35c5..018e7f6 100644
> --- a/testcases/realtime/README
> +++ b/testcases/realtime/README
> @@ -30,10 +30,8 @@ and latency measurement tests.  This is still a work in 
> (early) progress!
> 
>  DEPENDENCIES
>  ============
> -It is recommended that you have automake-1.9.6-2.1 or above.
> -If you see errors during your configure, please upgrade to
> -this version and autoconf-2.61.
> -
> +The testsuite expects glibc ("C" library) and the underlying kernel 
> +to support Robust and Priority Inheritance (PI) Mutexes.

Perhaps specifying the minimum glibc version would be appropriate?

> 
>  RUNNING TESTS THROUGH LTP
>  =========================
> @@ -43,11 +41,11 @@ argument provided to the script.
> 
>  Run command below from LTP root directory with argument:
> 
> -        $./testscripts/test_realtime.sh $arg
> +        $./testscripts/test_realtime.sh -t $arg
> 
>          or
> 
> -        $./test_realtime.sh $arg   # From $LTPROOT/testscripts directory
> +        $./test_realtime.sh -t $arg   # From $LTPROOT/testscripts directory
> 
>  Here $arg takes values as :
> 
> @@ -62,11 +60,9 @@ Here $arg takes values as :
> 
>  BUILD
>  =====
> -As of April 2007, we include autoconf support (based on Robert
> -Schwebel's contributed patch). To build the tests:
> +To build the tests execute the following command:
> 
> -1. ./configure
> -2. make
> +make

Other commands are indented with a tab and are prefaced with a prompt
character.

> 
> 
>  RUNNING THE TESTS
> @@ -80,16 +76,17 @@ The top level script run.sh can be used to invoke all or 
> a subset of tests.
> 
>  2. Running the script with the list option will list the available tests.
> 
> -        #]> run.sh list
> +        #]> run.sh -t list

Weird prompt...  Suggest "$ " to indicate a user prompt, and "# " to
indicate a root prompt.

> 
>     Note that the tests available are determined by the presence
>     of a local script run_auto.sh in the individual test subdirectories
>     at this time.
> 
> 
> -3. Individual tests can also be run. For example, to run the prio-wake tests:
> +3. Individual tests can also be run. For example, to run the prio-wake tests
> +   for 20 iterations:
> 
> -        #]> run.sh func/prio-wake
> +        #]> run.sh -t func/prio-wake -l 20

Weird prompt...

> 
>     Note, the test must be specified with the path relative to the test
>     home (where run.sh lives).
> @@ -104,15 +101,15 @@ The top level script run.sh can be used to invoke all 
> or a subset of tests.
> 
>  5. You can also run sets of tests:
> 
> -        #]> run.sh func
> +        #]> run.sh -t func
> 
> -        will run all the functional tests
> +        will run all the functional tests once
> 
> -        #]> run.sh perf
> +        #]> run.sh -t perf -l 3

More weird prompts..

> 
> -        will run all the perf tests (if any!)
> +        will run all the perf tests (if any!) thrice
> 
> -        Use the list option to see the various arguments taken.
> +        Use the -h option to see the various arguments taken.
> 
>  6. Or you can run the binaries...
> 
> diff --git a/testcases/realtime/doc/HOWTO_ADD_TESTS 
> b/testcases/realtime/doc/HOWTO_ADD_TESTS
> index 2f51df2..4fbf6f7 100644
> --- a/testcases/realtime/doc/HOWTO_ADD_TESTS
> +++ b/testcases/realtime/doc/HOWTO_ADD_TESTS
> @@ -8,7 +8,7 @@ rt-test - HOWTO_ADD_TESTS
>       - note that only the top level subdirectory
>         (which has a run_auto.sh script) gets listed
>         individually as an available test.
> -     - run "run.sh list" to see available tests
> +     - run "run.sh -t list" to see available tests
> 
>  2. If you are creating a new subdirectory:
>     Provide:
> @@ -22,10 +22,10 @@ rt-test - HOWTO_ADD_TESTS
> 
>  4. Test the following:
>       sh autogen.sh; ./configure, make, naturally
> -     run.sh list
> -     run.sh clean
> -     run.sh subdir # entire bucket
> -     run.sh subdir/your_test_dir
> +     run.sh -t list
> +     run.sh -t clean
> +     run.sh -t subdir # entire bucket
> +     run.sh -t subdir/your_test_dir
>       subdir/your_test_dir/run_auto.sh

Add prompt characters for consistency.

> 
>  5. Test source files:
> 

Thanks,

-- 
Darren Hart
Real-Time Linux Team Lead
IBM Linux Technology Center


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Ltp-list mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ltp-list

Reply via email to