From patchwork Wed Oct 14 09:28:20 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stuart Haslam X-Patchwork-Id: 54894 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f198.google.com (mail-wi0-f198.google.com [209.85.212.198]) by patches.linaro.org (Postfix) with ESMTPS id 4DB6420490 for ; Wed, 14 Oct 2015 09:37:22 +0000 (UTC) Received: by wibzt1 with SMTP id zt1sf24168497wib.0 for ; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:in-reply-to:references:subject:precedence:list-id :list-unsubscribe:list-archive:list-post:list-help:list-subscribe :mime-version:content-type:content-transfer-encoding:errors-to :sender:x-original-sender:x-original-authentication-results :mailing-list; bh=Pro6gjqs9x/2H/2NcwA7tVvWV4z3E/I8Vegd+haunOo=; b=TaDGSvBavW9BGiOdQFnxQlPGAKWipPiEGq9Pd4g+CwArU0odvHexFxJkCYY6UDHxy+ KmVpacBWLhzeLTvs53wo5QLnbrV9+jb9SoSHrURti/YwiQ+0VEwsomEuDcmIDzMjvsLS P084FCoNeL1Jad5JU85475KW2rk0KLg3k8WEyuk30aoow060GPg4+IMA2kMiIM7Q2iJb uLKobH0hcwJykZ2bIeYhsH9ICR1GAFzj+vhH8AylSar6J0PxVL/EDlFjYy70+EvCUgAc hj941uUy9IlA4KLffUiASXv89a4LnVl993xG8Hwpae/S+QciQ9MCvvMtDO1eIfeUbM07 NZow== X-Gm-Message-State: ALoCoQly9gbEnWkppBlFK0aKWuj9YbZg4woTqufYO6G4tEWEaFpzls8sstTO+MfLOjzcMIdONa60 X-Received: by 10.112.55.69 with SMTP id q5mr521395lbp.24.1444815441566; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.163.194 with SMTP id m185ls16192lfe.66.gmail; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) X-Received: by 10.25.77.133 with SMTP id a127mr692614lfb.19.1444815441431; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) Received: from mail-lf0-f51.google.com (mail-lf0-f51.google.com. [209.85.215.51]) by mx.google.com with ESMTPS id m5si4945808lbp.169.2015.10.14.02.37.21 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 14 Oct 2015 02:37:21 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) client-ip=209.85.215.51; Received: by lffv3 with SMTP id v3so8342751lff.0 for ; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) X-Received: by 10.25.86.213 with SMTP id k204mr690682lfb.36.1444815441173; Wed, 14 Oct 2015 02:37:21 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.59.35 with SMTP id w3csp2612645lbq; Wed, 14 Oct 2015 02:37:20 -0700 (PDT) X-Received: by 10.140.97.7 with SMTP id l7mr2646685qge.32.1444815440060; Wed, 14 Oct 2015 02:37:20 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 9si6997826qhu.104.2015.10.14.02.37.19; Wed, 14 Oct 2015 02:37:20 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id 7636661C7A; Wed, 14 Oct 2015 09:37:19 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 7326761BBF; Wed, 14 Oct 2015 09:29:54 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 27EBA61D4C; Wed, 14 Oct 2015 09:29:50 +0000 (UTC) Received: from mail-wi0-f178.google.com (mail-wi0-f178.google.com [209.85.212.178]) by lists.linaro.org (Postfix) with ESMTPS id 0971F61BAF for ; Wed, 14 Oct 2015 09:29:11 +0000 (UTC) Received: by wicgb1 with SMTP id gb1so222300243wic.1 for ; Wed, 14 Oct 2015 02:29:10 -0700 (PDT) X-Received: by 10.180.88.198 with SMTP id bi6mr27795105wib.75.1444814949214; Wed, 14 Oct 2015 02:29:09 -0700 (PDT) Received: from e106441.emea.arm.com ([2001:41d0:a:3cb4::abcd]) by smtp.gmail.com with ESMTPSA id m6sm6323270wif.11.2015.10.14.02.29.08 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 14 Oct 2015 02:29:08 -0700 (PDT) From: Stuart Haslam To: lng-odp@lists.linaro.org Date: Wed, 14 Oct 2015 10:28:20 +0100 Message-Id: <1444814900-14384-6-git-send-email-stuart.haslam@linaro.org> X-Mailer: git-send-email 2.1.1 In-Reply-To: <1444814900-14384-1-git-send-email-stuart.haslam@linaro.org> References: <1444814900-14384-1-git-send-email-stuart.haslam@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv3 5/5] validation: update README X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: stuart.haslam@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) smtp.mailfrom=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Remove information that's now duplicated in the Implementers' Guide and instead just refer to it. Signed-off-by: Stuart Haslam Reviewed-by: Christophe Milard --- test/validation/README | 55 ++++++++++++++++++-------------------------------- 1 file changed, 20 insertions(+), 35 deletions(-) diff --git a/test/validation/README b/test/validation/README index 2d0c258..1baebaa 100644 --- a/test/validation/README +++ b/test/validation/README @@ -4,47 +4,32 @@ All rights reserved. SPDX-License-Identifier: BSD-3-Clause -To add tests in here, please observe the following rules: +To add tests in here, please observe the rules listed below. This list +is a brief overview, for a more detailed explanation of the test +framework refer to the ODP Implementers' Guide, which can built as +follows: -1. Tests should be placed in the directory of the module they belong to. + ./configure --enable-user-guides + make +Output will be in doc/output/. If this fails, check the documentation +section of the DEPENDENCIES file. -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 - - Tests that do not follow these rules should be placed in the platform - specific test area (currently platform//test*) - - -3. If a new ODP API module is created, please update the Makefile.am and - the odptest.h file +Rules for all tests under this tree: +1. Tests must be placed in the directory of the module they belong to. -4. Respect the following name convention for the names exported in the library: +2. Tests must be platform agnostic, i.e. - * Tests, i.e. functions which are used in CUNIT test suites are named: - *_test_* + - 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 - * Test arrays, i.e. arrays of CU_TestInfo, listing the test functions - belonging to a suite, are called: - _suite[_*] - where the possible suffix can be used if many suites are declared. - - * CUNIT suite init and termination functions are called: - _suite[_*]_init() and _suite[_*]_term() - respectively. - - * Suite arrays, i.e. arrays of CU_SuiteInfo used in executables are called: - _suites[_*] - where the possible suffix identifies the executable using it, if many. + Tests that do not follow these rules should be placed in the platform + specific test area (currently platform//test/). - * Main executable function(s), are called: - _main[_*]* - where the possible suffix identifies the executable using it +3. If a new ODP API module is created, please update the Makefile.am. - * Init/term function for the whole executable are called: - _init - _term +4. Symbols exported from test libraries must respect the naming + convention detailed in the ODP Implementers' Guide.