From patchwork Tue Oct 13 16:41:39 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stuart Haslam X-Patchwork-Id: 54859 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f200.google.com (mail-wi0-f200.google.com [209.85.212.200]) by patches.linaro.org (Postfix) with ESMTPS id 765AE20490 for ; Tue, 13 Oct 2015 16:46:52 +0000 (UTC) Received: by wicid10 with SMTP id id10sf13438312wic.2 for ; Tue, 13 Oct 2015 09:46:51 -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=dBsmg8kDXTnVZvYwD3WhPVVTJM5+e205mnaAo6NCnJ0=; b=DRUe1WnHT6+FerheUu8oKQjZcbQ23w1UsLEX+yZOBxU77b2z1Vy6YKqYRJmPh21TeR AqhYuTluNoUTu6Z5RKjiW/NrfYnFJo4sQyB5OtFRHk6eg16+XDQx9AdT0wvUep2LByCa Nf/Tfv/9XVAGVuEAXqNHjk/KUPdPoPenM+7lzZL/l9YK2TZ6pPt/WO4O4sjPbUT6B1FL pM/txpEqX6D0cF3E0stN5yabrLNQgSVpVCB7Q00TGMU5pkQ5l4Qu8uO36O6wMrHWSWYI mBS4difGMwublu2B5JOi+jPhiqVHJHWOdysb4LD11YwpmOvJvZmBSWNXIEKruQAAkNRR Nydg== X-Gm-Message-State: ALoCoQkeQ83oeb5yjdLI8JMQltpOzSQjLhn93zp0T/BFJfdiuJfsqbU0uNOc/KbYQ/dBdXBoY+hH X-Received: by 10.112.173.136 with SMTP id bk8mr7293492lbc.20.1444754811769; Tue, 13 Oct 2015 09:46:51 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.18.90 with SMTP id h87ls400106lfi.9.gmail; Tue, 13 Oct 2015 09:46:51 -0700 (PDT) X-Received: by 10.112.155.195 with SMTP id vy3mr15730579lbb.9.1444754811481; Tue, 13 Oct 2015 09:46:51 -0700 (PDT) Received: from mail-lb0-f182.google.com (mail-lb0-f182.google.com. [209.85.217.182]) by mx.google.com with ESMTPS id n187si2701388lfb.31.2015.10.13.09.46.51 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 13 Oct 2015 09:46:51 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.182 as permitted sender) client-ip=209.85.217.182; Received: by lbcao8 with SMTP id ao8so27511429lbc.3 for ; Tue, 13 Oct 2015 09:46:51 -0700 (PDT) X-Received: by 10.25.205.198 with SMTP id d189mr10228861lfg.72.1444754811327; Tue, 13 Oct 2015 09:46:51 -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 w3csp2237129lbq; Tue, 13 Oct 2015 09:46:50 -0700 (PDT) X-Received: by 10.50.134.73 with SMTP id pi9mr21877482igb.20.1444754809026; Tue, 13 Oct 2015 09:46:49 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id n137si3766183ion.3.2015.10.13.09.46.48; Tue, 13 Oct 2015 09:46:48 -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 16CCC61BFD; Tue, 13 Oct 2015 16:46:48 +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 A405761C6A; Tue, 13 Oct 2015 16:42:41 +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 8335A61BFD; Tue, 13 Oct 2015 16:42:20 +0000 (UTC) Received: from mail-wi0-f176.google.com (mail-wi0-f176.google.com [209.85.212.176]) by lists.linaro.org (Postfix) with ESMTPS id 82B2761BC1 for ; Tue, 13 Oct 2015 16:42:11 +0000 (UTC) Received: by wicgb1 with SMTP id gb1so96500527wic.1 for ; Tue, 13 Oct 2015 09:42:10 -0700 (PDT) X-Received: by 10.194.172.1 with SMTP id ay1mr14832461wjc.101.1444754530519; Tue, 13 Oct 2015 09:42:10 -0700 (PDT) Received: from e106441.emea.arm.com ([2001:41d0:a:3cb4::abcd]) by smtp.gmail.com with ESMTPSA id r4sm15688622wia.19.2015.10.13.09.42.09 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 13 Oct 2015 09:42:10 -0700 (PDT) From: Stuart Haslam To: lng-odp@lists.linaro.org Date: Tue, 13 Oct 2015 17:41:39 +0100 Message-Id: <1444754499-10464-6-git-send-email-stuart.haslam@linaro.org> X-Mailer: git-send-email 2.1.1 In-Reply-To: <1444754499-10464-1-git-send-email-stuart.haslam@linaro.org> References: <1444754499-10464-1-git-send-email-stuart.haslam@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv2 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.217.182 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 --- 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//test*) + specific test area (currently 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: - *_test_* - - * 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. - - * Main executable function(s), are called: - _main[_*]* - where the possible suffix identifies the executable using it - - * Init/term function for the whole executable are called: - _init - _term