From patchwork Thu Aug 4 14:08:31 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 73274 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp1414466qga; Thu, 4 Aug 2016 07:08:45 -0700 (PDT) X-Received: by 10.55.21.150 with SMTP id 22mr6578272qkv.273.1470319724963; Thu, 04 Aug 2016 07:08:44 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id e35si8325830qte.108.2016.08.04.07.08.41; Thu, 04 Aug 2016 07:08:44 -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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 05A6C60698; Thu, 4 Aug 2016 14:08:41 +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 A984760690; Thu, 4 Aug 2016 14:08:37 +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 1E42660693; Thu, 4 Aug 2016 14:08:36 +0000 (UTC) Received: from mail-qk0-f180.google.com (mail-qk0-f180.google.com [209.85.220.180]) by lists.linaro.org (Postfix) with ESMTPS id 331B86068D for ; Thu, 4 Aug 2016 14:08:35 +0000 (UTC) Received: by mail-qk0-f180.google.com with SMTP id x185so38952205qkc.2 for ; Thu, 04 Aug 2016 07:08:35 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=vyZhpLnZXsFfLucZcPuA9XclGaed0vxuuwVAj7AO+W8=; b=DqvqICTBZD2JAUq14pqSrfYY+pC+PKWuwdBnxz+tj5dv2+9B7QSVFzOZIhJUla1bdh eUi+6LjgDLWp/PCUvBHWH4/l363sT7lJzilTmyP6tFoNbowmvM0txeklHZIiMhmOEGTw 8/Kswnbon4YdhRFl/JL6j/6A+qsVftu7aWuu4+NTrp0EKViT8Vz0LW3RxQcE8uam4JFz bVuCORDnMB/hh+E3BTU49/atnxebbhCUxvR32e3M4FU4MTC6bp3w4w6+5C2GREF/y0qA qrxhYE9LjE09SmQKqKawrJ/Z7JtqBV02eWYwAu7hLmVYT46upJEHYYaCI8Lepy2tu2mv 4U/A== X-Gm-Message-State: AEkoouuGVNtTVzITTXCl4zXWhu7YE4doSXkupumI1ikDFUFzk/fYKj5lOK9hTA7P0Z9EdrELmKw= X-Received: by 10.55.217.134 with SMTP id q6mr6786672qkl.271.1470319714664; Thu, 04 Aug 2016 07:08:34 -0700 (PDT) Received: from localhost (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id w16sm7029181qta.10.2016.08.04.07.08.33 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 04 Aug 2016 07:08:34 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Thu, 4 Aug 2016 10:08:31 -0400 Message-Id: <1470319711-17957-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH] doc/implementers add internal prefix recommendation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Promote coding style that reduces the chance of collisions with applications. Signed-off-by: Mike Holmes --- doc/implementers-guide/implementers-guide.adoc | 7 +++++++ 1 file changed, 7 insertions(+) -- 2.7.4 diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index 5c0e864..829f316 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -182,6 +182,13 @@ recommended that other implementations follow the same schema (*odp-*) to make the representation of the ODP implementations uniform in a distribution. +== ODP internal function naming recommendations +When symbols are required that may leak into the external API definition they +should be prefixed _odp to reduce the chance of a name collision. + +Whenever possible internal functions should be static to reduce link time issues +. + [[validation]] == The Validation Suite ODP provides a comprehensive set of API validation tests that are intended to be