Re: [PATCH 3/3] README : Update README file related to usage of FORMAT make variable

On Tue, Aug 05, 2014 at 02:31:58PM +0530, Ravi Nanjundappa wrote:
> Signed-off-by: Ravi Nanjundappa <[email protected]>
> ---
>  test/README |   10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/test/README b/test/README
> index e8e7189..c1ff19d 100644
> --- a/test/README
> +++ b/test/README
> @@ -49,6 +49,16 @@ should be a space-separated list of tests to run.  For example:
>  
>    CAIRO_TESTS="zero-alpha" make test TARGETS=image,ps
>  

Whew the documentation for these variables is starting to get a bit
obtuse due to the variations.  Perhaps a few more changes can simplify
things a bit...

> +To limit the content formats that the tests are run against, use the
> +FORMAT make variable, that can also be passed to make.

This sentence is a little cumbersome.

make's FORMAT variable is used to limit the content formats when running
tests.

> +It should contain a (space-, comma-, etc-separated) list of content formats to test.

Let's just go with space- and comma- as separators for simplicity, and
let other separators just be undocumented features.

> +To limit the tests run, use the CAIRO_TESTS environment variable, which
> +should be a space-separated list of tests to run and also to limit the

For consistency, let's make CAIRO_TESTS accept either/both space and
comma as separators.  Even though it's an env var rather than a make
var, it should still work fine that way.

> +backends, use TARGETS environment variable, which should be a space-, comma-,
> +etc-separated lists of backends.  For example:

This ends a quite long (4-line) sentence.  Let's break that up into two
sentences, one for each variable.  And since all three variables use the
same separators, that bit can be mentioned just once.

> +  CAIRO_TESTS="zero-alpha" make test TARGETS=image,ps FORMAT="rgb,rgba"
> +

Thanks for remembering to update the documentation btw, it saves us all
from future confusions!  :-)

Bryce

>  Another very handy mechanism when trying to fix bugs is:
>  
>    make retest
> -- 
> 1.7.9.5
> 
> -- 
> cairo mailing list
> [email protected]
> http://lists.cairographics.org/mailman/listinfo/cairo
-- 
cairo mailing list
[email protected]
http://lists.cairographics.org/mailman/listinfo/cairo