From patchwork Tue Oct 13 16:41:37 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stuart Haslam X-Patchwork-Id: 54856 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f197.google.com (mail-wi0-f197.google.com [209.85.212.197]) by patches.linaro.org (Postfix) with ESMTPS id 8C8BE20490 for ; Tue, 13 Oct 2015 16:43:11 +0000 (UTC) Received: by wicgb1 with SMTP id gb1sf13535552wic.3 for ; Tue, 13 Oct 2015 09:43:10 -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=RZqZXJLjm01mg8K5bZgkWh5hJWy5NLta7vMlsRKQxFFodrjfKdQPZbIIkMmqcP8dm0 T09IhBb2QFf/Orgy3dotuReaMs8oeaOsPQs5siAqqqq0FGMviMzWlIgXB5laf6tmlBUb IEaD5zMH7ODWcB/zwQ3jSrEY/29KQZx99B9QOAyatoDNN///OijgFdtNXrmjJA+tB6te ajPmDcK/ZuCCv0Cg9Gw7ay4aDPnP4+0/VFrbxEt4697x784LKfDGTwg7bxgbh810hISh /jgSi7e0i3KJukEZKc0fdFuqXX7fPNjzigLm1I7dKyoKJr8pQwUkhkKgXfJZSng6sJ7t xROw== X-Gm-Message-State: ALoCoQn6aGQfs4K+LRIOR/HDTdcKMa2lGSu6dbwzCA34t2FfBuxwt/CjWSdqzzGOHJzjBEBcVgPS X-Received: by 10.112.142.195 with SMTP id ry3mr7324806lbb.22.1444754590710; Tue, 13 Oct 2015 09:43:10 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.152.199 with SMTP id a190ls687702lfe.62.gmail; Tue, 13 Oct 2015 09:43:10 -0700 (PDT) X-Received: by 10.112.171.69 with SMTP id as5mr15339063lbc.111.1444754590572; Tue, 13 Oct 2015 09:43:10 -0700 (PDT) Received: from mail-lb0-f178.google.com (mail-lb0-f178.google.com. [209.85.217.178]) by mx.google.com with ESMTPS id dr7si2665439lbc.106.2015.10.13.09.43.10 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 13 Oct 2015 09:43:10 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.178 as permitted sender) client-ip=209.85.217.178; Received: by lbcao8 with SMTP id ao8so27403517lbc.3 for ; Tue, 13 Oct 2015 09:43:10 -0700 (PDT) X-Received: by 10.112.168.228 with SMTP id zz4mr15788384lbb.73.1444754590377; Tue, 13 Oct 2015 09:43:10 -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 w3csp2235513lbq; Tue, 13 Oct 2015 09:43:09 -0700 (PDT) X-Received: by 10.140.93.195 with SMTP id d61mr20232185qge.89.1444754589422; Tue, 13 Oct 2015 09:43:09 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 104si3562997qgl.102.2015.10.13.09.43.09; Tue, 13 Oct 2015 09:43:09 -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 0E62061BFD; Tue, 13 Oct 2015 16:43:09 +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 8E4B761BBF; Tue, 13 Oct 2015 16:42:26 +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 BC39461C6A; Tue, 13 Oct 2015 16:42:13 +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 A857A61A1E for ; Tue, 13 Oct 2015 16:42:09 +0000 (UTC) Received: by wicge5 with SMTP id ge5so66540736wic.0 for ; Tue, 13 Oct 2015 09:42:08 -0700 (PDT) X-Received: by 10.194.90.168 with SMTP id bx8mr18556788wjb.0.1444754528849; Tue, 13 Oct 2015 09:42:08 -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.08 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 13 Oct 2015 09:42:08 -0700 (PDT) From: Stuart Haslam To: lng-odp@lists.linaro.org Date: Tue, 13 Oct 2015 17:41:37 +0100 Message-Id: <1444754499-10464-4-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 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.178 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 --- 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.