From patchwork Wed Oct 14 09:28:18 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stuart Haslam X-Patchwork-Id: 54891 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by patches.linaro.org (Postfix) with ESMTPS id C971320490 for ; Wed, 14 Oct 2015 09:29:57 +0000 (UTC) Received: by lbwr8 with SMTP id r8sf22687438lbw.0 for ; Wed, 14 Oct 2015 02:29:56 -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=MlD9oNyIHaqHydAHJh7Gbb9rBpNhBrb1fGwFffR712g=; b=bNJN2t3CsjxB2ayKn/+xrp8+smVoO/K/uFjzzBBuFmksM/VMjjJrZucQ/qtER7n/Yi wO7XUDsUGnqUW4ums9AnTtHeReooY1A0aJdPS1IrNJOXOtso3BuuS22Hsnt8doFegLvX /KwN45Pxb/Fq0ay4/tgshjqriABpKkQ31f27IC6ElRP8N3bhqbPQxefKewyZL8nTOKkI 175YWIFZDZBhPItLX8P3TepAwIowGxUSC6VfZli5YOdh9ohR/kgcOWAsQ7zkZsSJWYbh q8yOKOyNA0zVEce6JNbITIEzYLTG6bg9aDS/A8PaR17qX1XfVCDHzlQy8pxNeo5Bq9v/ 9x6w== X-Gm-Message-State: ALoCoQkHUO4szw2GC4wnmr5qO5iyOkI+j8J/2wc6QwezdS9LSkk18whFEqrPivcfsChM7NXSb0AX X-Received: by 10.180.9.104 with SMTP id y8mr5271356wia.7.1444814996786; Wed, 14 Oct 2015 02:29:56 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.39.6 with SMTP id n6ls15038lfn.36.gmail; Wed, 14 Oct 2015 02:29:56 -0700 (PDT) X-Received: by 10.112.163.131 with SMTP id yi3mr1033156lbb.36.1444814996505; Wed, 14 Oct 2015 02:29:56 -0700 (PDT) Received: from mail-lb0-f176.google.com (mail-lb0-f176.google.com. [209.85.217.176]) by mx.google.com with ESMTPS id ml15si4958306lbb.48.2015.10.14.02.29.56 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 14 Oct 2015 02:29:56 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.176 as permitted sender) client-ip=209.85.217.176; Received: by lbwr8 with SMTP id r8so41616295lbw.2 for ; Wed, 14 Oct 2015 02:29:56 -0700 (PDT) X-Received: by 10.112.135.9 with SMTP id po9mr1055481lbb.56.1444814996378; Wed, 14 Oct 2015 02:29:56 -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 w3csp2608803lbq; Wed, 14 Oct 2015 02:29:55 -0700 (PDT) X-Received: by 10.140.98.183 with SMTP id o52mr2472220qge.70.1444814995227; Wed, 14 Oct 2015 02:29:55 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 203si7014970qhu.22.2015.10.14.02.29.54; Wed, 14 Oct 2015 02:29:55 -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 A54C161BC1; Wed, 14 Oct 2015 09:29:54 +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 827FC61CE8; Wed, 14 Oct 2015 09:29:12 +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 7830961CE8; Wed, 14 Oct 2015 09:29:07 +0000 (UTC) Received: from mail-wi0-f180.google.com (mail-wi0-f180.google.com [209.85.212.180]) by lists.linaro.org (Postfix) with ESMTPS id 77BC761BC1 for ; Wed, 14 Oct 2015 09:29:03 +0000 (UTC) Received: by wicge5 with SMTP id ge5so92221361wic.0 for ; Wed, 14 Oct 2015 02:29:02 -0700 (PDT) X-Received: by 10.180.223.102 with SMTP id qt6mr3049666wic.11.1444814942672; Wed, 14 Oct 2015 02:29:02 -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.01 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 14 Oct 2015 02:29:02 -0700 (PDT) From: Stuart Haslam To: lng-odp@lists.linaro.org Date: Wed, 14 Oct 2015 10:28:18 +0100 Message-Id: <1444814900-14384-4-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 3/5] doc: implementers-guide: update names of test module libraries 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.176 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 The name of the libraries generated by the test modules were recently changed from lib.la to libtest.la Signed-off-by: Stuart Haslam Reviewed-by: Christophe Milard --- doc/implementers-guide/implementers-guide.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index 32dbfea..090d4e5 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -77,7 +77,7 @@ Examples of modules includes "classification" (API functions dealing with ingres The complete module list can be seen at: http://docs.opendataplane.org/linux-generic-doxygen-html/modules.html[ODP Modules] + Within the platform agnostic area, the tests are also grouped by modules, matching the ODP API modules: '/test/validation/' mainly contains a list of directories matching each module name (as defined by the doxygen "@defgroup" or "@ingroup" statement present in each API ".h" file). -Within each of these directories, a library (called "lib.la") and its associated ".h" file (called ".h") defines all the test functions for this module as well as few other functions to initialize, terminate, and group the tests. +Within each of these directories, a library (called "libtest.la") and its associated ".h" file (called ".h") defines all the test functions for this module as well as few other functions to initialize, terminate, and group the tests. An executable called "_main*", is also built. It is permissible to generate more than one executable to cover the functionality in the test library for the module. These executable(s) shall call all the tests for this module. + See <> for more details. @@ -130,7 +130,7 @@ Module test and naming convention *_init* *_term* -All the above symbols are part of the generated lib.la libraries. The generated main executable(s) (named _+++main[_*]+++, where the optional suffix is used to distinguish the executables belonging to the same module, if many) simply call(s) the related _main+++[_*]+++ from the library. +All the above symbols are part of the generated libtest.la libraries. The generated main executable(s) (named _+++main[_*]+++, where the optional suffix is used to distinguish the executables belonging to the same module, if many) simply call(s) the related _main+++[_*]+++ from the library. Platform specific ~~~~~~~~~~~~~~~~~ @@ -234,7 +234,7 @@ Sometimes, it may be necessary to call platform specific system calls to check s Skipping tests during development ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -During ODP development, it may be useful to skip some test. This can be achieved by creating a new test executable (still on the platform side), picking up the required tests from the platform agnostic lib.la. +During ODP development, it may be useful to skip some test. This can be achieved by creating a new test executable (still on the platform side), picking up the required tests from the platform agnostic libtest.la. The top Makefile would then call only the platform specific executable, hence skipping the tests which have been omitted.