| Message ID | 1444754499-10464-6-git-send-email-stuart.haslam@linaro.org |
|---|---|
| State | New |
| Headers | show |
On 13 October 2015 at 18:41, Stuart Haslam <stuart.haslam@linaro.org> wrote: > Remove information that's now duplicated in the Implementers' Guide and > instead just refer to it. > > Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> > --- > test/validation/README | 45 ++++++++++----------------------------------- > 1 file changed, 10 insertions(+), 35 deletions(-) > > diff --git a/test/validation/README b/test/validation/README > index 2d0c258..6a8ecda 100644 > --- a/test/validation/README > +++ b/test/validation/README > @@ -6,45 +6,20 @@ SPDX-License-Identifier: BSD-3-Clause > > To add tests in here, please observe the following rules: > > -1. Tests should be placed in the directory of the module they belong to. > +1. Tests must be placed in the directory of the module they belong to. > > +2. Tests must be platform agnostic, i.e. > > -2. Test under test/validation/... should be platform agnostic, i.e. > - -they should be written in plain C only > - -they may only used Clib functions, C_UNIT functions and of course > ODP > - functions. > - -they should be expected to pass on all ODP implementation > + - should be written in plain C only. > + - may only use C standard library functions, CUnit functions and of > + course ODP functions > + - should be expected to pass on all ODP implementations > > Tests that do not follow these rules should be placed in the platform > - specific test area (currently platform/<platform>/test*) > + specific test area (currently platform/<platform>/test/). > > +3. If a new ODP API module is created, please update the Makefile.am. > > -3. If a new ODP API module is created, please update the Makefile.am and > - the odptest.h file > +4. Symbols exported from test libraries must respect the naming > + convention detailed in the ODP Implementers' Guide. > The path to it would be nice here: <ODP>/doc/implementers-guide/implementers-guide.html As well as how to build the doc (make target or ascii-doc) Christophe - > -4. Respect the following name convention for the names exported in the > library: > - > - * Tests, i.e. functions which are used in CUNIT test suites are named: > - *<Module>_test_* > - > - * Test arrays, i.e. arrays of CU_TestInfo, listing the test functions > - belonging to a suite, are called: > - <Module>_suite[_*] > - where the possible suffix can be used if many suites are declared. > - > - * CUNIT suite init and termination functions are called: > - <Module>_suite[_*]_init() and <Module>_suite[_*]_term() > - respectively. > - > - * Suite arrays, i.e. arrays of CU_SuiteInfo used in executables are > called: > - <Module>_suites[_*] > - where the possible suffix identifies the executable using it, if many. > - > - * Main executable function(s), are called: > - <Module>_main[_*]* > - where the possible suffix identifies the executable using it > - > - * Init/term function for the whole executable are called: > - <Module>_init > - <Module>_term > -- > 2.1.1 > >
On Wed, Oct 14, 2015 at 09:04:14AM +0200, Christophe Milard wrote: > On 13 October 2015 at 18:41, Stuart Haslam <stuart.haslam@linaro.org> wrote: > > > Remove information that's now duplicated in the Implementers' Guide and > > instead just refer to it. > > > > Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> > > --- > > test/validation/README | 45 ++++++++++----------------------------------- > > 1 file changed, 10 insertions(+), 35 deletions(-) > > > > diff --git a/test/validation/README b/test/validation/README > > index 2d0c258..6a8ecda 100644 > > --- a/test/validation/README > > +++ b/test/validation/README > > @@ -6,45 +6,20 @@ SPDX-License-Identifier: BSD-3-Clause > > > > To add tests in here, please observe the following rules: > > > > -1. Tests should be placed in the directory of the module they belong to. > > +1. Tests must be placed in the directory of the module they belong to. > > > > +2. Tests must be platform agnostic, i.e. > > > > -2. Test under test/validation/... should be platform agnostic, i.e. > > - -they should be written in plain C only > > - -they may only used Clib functions, C_UNIT functions and of course > > ODP > > - functions. > > - -they should be expected to pass on all ODP implementation > > + - should be written in plain C only. > > + - may only use C standard library functions, CUnit functions and of > > + course ODP functions > > + - should be expected to pass on all ODP implementations > > > > Tests that do not follow these rules should be placed in the platform > > - specific test area (currently platform/<platform>/test*) > > + specific test area (currently platform/<platform>/test/). > > > > +3. If a new ODP API module is created, please update the Makefile.am. > > > > -3. If a new ODP API module is created, please update the Makefile.am and > > - the odptest.h file > > +4. Symbols exported from test libraries must respect the naming > > + convention detailed in the ODP Implementers' Guide. > > > > The path to it would be nice here: > <ODP>/doc/implementers-guide/implementers-guide.html > As well as how to build the doc (make target or ascii-doc) > OK.
diff --git a/test/validation/README b/test/validation/README index 2d0c258..6a8ecda 100644 --- a/test/validation/README +++ b/test/validation/README @@ -6,45 +6,20 @@ SPDX-License-Identifier: BSD-3-Clause To add tests in here, please observe the following rules: -1. Tests should be placed in the directory of the module they belong to. +1. Tests must be placed in the directory of the module they belong to. +2. Tests must be platform agnostic, i.e. -2. Test under test/validation/... should be platform agnostic, i.e. - -they should be written in plain C only - -they may only used Clib functions, C_UNIT functions and of course ODP - functions. - -they should be expected to pass on all ODP implementation + - should be written in plain C only. + - may only use C standard library functions, CUnit functions and of + course ODP functions + - should be expected to pass on all ODP implementations Tests that do not follow these rules should be placed in the platform - specific test area (currently platform/<platform>/test*) + specific test area (currently platform/<platform>/test/). +3. If a new ODP API module is created, please update the Makefile.am. -3. If a new ODP API module is created, please update the Makefile.am and - the odptest.h file +4. Symbols exported from test libraries must respect the naming + convention detailed in the ODP Implementers' Guide. - -4. Respect the following name convention for the names exported in the library: - - * Tests, i.e. functions which are used in CUNIT test suites are named: - *<Module>_test_* - - * Test arrays, i.e. arrays of CU_TestInfo, listing the test functions - belonging to a suite, are called: - <Module>_suite[_*] - where the possible suffix can be used if many suites are declared. - - * CUNIT suite init and termination functions are called: - <Module>_suite[_*]_init() and <Module>_suite[_*]_term() - respectively. - - * Suite arrays, i.e. arrays of CU_SuiteInfo used in executables are called: - <Module>_suites[_*] - where the possible suffix identifies the executable using it, if many. - - * Main executable function(s), are called: - <Module>_main[_*]* - where the possible suffix identifies the executable using it - - * Init/term function for the whole executable are called: - <Module>_init - <Module>_term
Remove information that's now duplicated in the Implementers' Guide and instead just refer to it. Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> --- test/validation/README | 45 ++++++++++----------------------------------- 1 file changed, 10 insertions(+), 35 deletions(-)