From patchwork Wed Sep 16 09:42:02 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stuart Haslam X-Patchwork-Id: 53721 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by patches.linaro.org (Postfix) with ESMTPS id 2F40322DB2 for ; Wed, 16 Sep 2015 09:44:39 +0000 (UTC) Received: by lbcao8 with SMTP id ao8sf67132083lbc.1 for ; Wed, 16 Sep 2015 02:44:38 -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=VBWjVAQ2YF4x16qPZt2pJ8zkj/w7lSJs4Phv/6tcfRZWf5ukltyq24TAs3BiD3te92 3qufG4qJ4jJeRhdvuDVeq2jS/t64wgPS5SOhF3umLxZAex42NZlIqvhahxYza2xmxdn6 q8SB4QwAMmOunb/ZIYtEfATXWdPexmCQdWEcmSiV4xkaSAjc0qQyNCdAfbFIBIR9cU5B 9PGXGLfY/faawSeX7bD3/vWMK27+AqQyK0Ik2Hm3JHq567d2Cl2wJV7yzjWbtg6rpzk5 zL9lsNChzk8MADLhmj5ByBBYLrnsfz5LbZsGy2iKjJrz6XLd+nqtpEKx8WrDYYAYNmSl 1POQ== X-Gm-Message-State: ALoCoQmMshPaan0IFrQ2xz4MFqTVGoCS5uLGVFr2SalJySDgf4zuMTDSEsEVWc65ehUtKkaNNruM X-Received: by 10.180.105.98 with SMTP id gl2mr1769614wib.0.1442396678136; Wed, 16 Sep 2015 02:44:38 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.2.129 with SMTP id 1ls748541lau.58.gmail; Wed, 16 Sep 2015 02:44:37 -0700 (PDT) X-Received: by 10.152.10.71 with SMTP id g7mr27838855lab.61.1442396677829; Wed, 16 Sep 2015 02:44:37 -0700 (PDT) Received: from mail-la0-f45.google.com (mail-la0-f45.google.com. [209.85.215.45]) by mx.google.com with ESMTPS id m6si17629795lah.100.2015.09.16.02.44.37 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 16 Sep 2015 02:44:37 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.45 as permitted sender) client-ip=209.85.215.45; Received: by lanb10 with SMTP id b10so124639363lan.3 for ; Wed, 16 Sep 2015 02:44:37 -0700 (PDT) X-Received: by 10.112.180.230 with SMTP id dr6mr17035509lbc.72.1442396677674; Wed, 16 Sep 2015 02:44:37 -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 w3csp2328025lbq; Wed, 16 Sep 2015 02:44:36 -0700 (PDT) X-Received: by 10.140.98.238 with SMTP id o101mr39399178qge.70.1442396676477; Wed, 16 Sep 2015 02:44:36 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q72si21159332qkl.121.2015.09.16.02.44.35; Wed, 16 Sep 2015 02:44:36 -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 296AC61A29; Wed, 16 Sep 2015 09:44:35 +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 1565A61A3E; Wed, 16 Sep 2015 09:43:55 +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 6E39661A4E; Wed, 16 Sep 2015 09:43:49 +0000 (UTC) Received: from mail-wi0-f172.google.com (mail-wi0-f172.google.com [209.85.212.172]) by lists.linaro.org (Postfix) with ESMTPS id 54D02619BA for ; Wed, 16 Sep 2015 09:42:41 +0000 (UTC) Received: by wiclk2 with SMTP id lk2so64459410wic.0 for ; Wed, 16 Sep 2015 02:42:40 -0700 (PDT) X-Received: by 10.180.87.230 with SMTP id bb6mr16759759wib.26.1442396560475; Wed, 16 Sep 2015 02:42:40 -0700 (PDT) Received: from e106441.emea.arm.com ([2001:41d0:a:3cb4::abcd]) by smtp.gmail.com with ESMTPSA id kb5sm25580683wjc.17.2015.09.16.02.42.39 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 16 Sep 2015 02:42:40 -0700 (PDT) From: Stuart Haslam To: lng-odp@lists.linaro.org Date: Wed, 16 Sep 2015 10:42:02 +0100 Message-Id: <1442396523-18466-4-git-send-email-stuart.haslam@linaro.org> X-Mailer: git-send-email 2.1.1 In-Reply-To: <1442396523-18466-1-git-send-email-stuart.haslam@linaro.org> References: <1442396523-18466-1-git-send-email-stuart.haslam@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 3/4] 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.215.45 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.