From patchwork Mon Dec 1 15:35:56 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 41782 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f199.google.com (mail-lb0-f199.google.com [209.85.217.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 1AE5020672 for ; Mon, 1 Dec 2014 15:36:25 +0000 (UTC) Received: by mail-lb0-f199.google.com with SMTP id u10sf6747336lbd.2 for ; Mon, 01 Dec 2014 07:36:24 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state: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=DWoNUrgvy9UW/yY0RrFKkfrMdTThw2UNQFjzduHDJCg=; b=g5Hz/LKnhUOlbxWmV5h8mT5aBj7GcvvD03VQofD5sTcutj8srvJV7MlJso+lBJ0H/G QtyBihXdmZ+Oj0o5M8cY59A3Ii5Ur2If2PK6lC1sVbdDmU6BtrO4lebg7ZCGEm6MmEos ONqqabRnnopaAQMdWz1wRA+6atfrl58VVF8+TfoWqsomEw6+bOI8jFMV1IXxbTxrk7YA ebpkSLte0WfbQPVXPIDcZ+crqdxlp5QgeU9MTLgR+gTIgmBCjvhvr/BQETAA7aZd1FWC Nvx/ozWtSyYVeM6RvTqcoUOUe8FCsQZYHCZD9VCVqgAgsXnjG7HRz94sV5OBdokT39m0 jSSg== X-Gm-Message-State: ALoCoQkk8GFrOlcSg6hl4LTERVSEXK42kuJaw3RLFJK8kOBmgARiyNXoQsGiW08zRI/HweyR3ZUi X-Received: by 10.152.42.196 with SMTP id q4mr770325lal.6.1417448183950; Mon, 01 Dec 2014 07:36:23 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.153.11.6 with SMTP id ee6ls873378lad.7.gmail; Mon, 01 Dec 2014 07:36:23 -0800 (PST) X-Received: by 10.152.6.166 with SMTP id c6mr57432893laa.20.1417448183300; Mon, 01 Dec 2014 07:36:23 -0800 (PST) Received: from mail-la0-f41.google.com (mail-la0-f41.google.com. [209.85.215.41]) by mx.google.com with ESMTPS id aq3si17977638lbc.78.2014.12.01.07.36.23 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 01 Dec 2014 07:36:23 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.41 as permitted sender) client-ip=209.85.215.41; Received: by mail-la0-f41.google.com with SMTP id hv19so4382859lab.28 for ; Mon, 01 Dec 2014 07:36:23 -0800 (PST) X-Received: by 10.112.235.196 with SMTP id uo4mr56558092lbc.66.1417448182983; Mon, 01 Dec 2014 07:36:22 -0800 (PST) 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.184.201 with SMTP id ew9csp311893lbc; Mon, 1 Dec 2014 07:36:21 -0800 (PST) X-Received: by 10.140.107.201 with SMTP id h67mr43177058qgf.34.1417448180992; Mon, 01 Dec 2014 07:36:20 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id e2si20896923qag.18.2014.12.01.07.36.20 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 01 Dec 2014 07:36:20 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XvT1O-00057e-Af; Mon, 01 Dec 2014 15:36:18 +0000 Received: from mail-qc0-f176.google.com ([209.85.216.176]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XvT1H-00057R-9A for lng-odp@lists.linaro.org; Mon, 01 Dec 2014 15:36:11 +0000 Received: by mail-qc0-f176.google.com with SMTP id i17so7814197qcy.21 for ; Mon, 01 Dec 2014 07:36:06 -0800 (PST) X-Received: by 10.140.85.104 with SMTP id m95mr43838531qgd.93.1417448165961; Mon, 01 Dec 2014 07:36:05 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id i32sm17574555qgf.12.2014.12.01.07.36.04 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 01 Dec 2014 07:36:05 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 1 Dec 2014 10:35:56 -0500 Message-Id: <1417448157-32769-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 In-Reply-To: <5476F65D.8000907@linaro.org> References: <5476F65D.8000907@linaro.org> X-Topics: Architecture patch Subject: [lng-odp] [PATCHv2 ARCH] api_guide_lines: Internal functions X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 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-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@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.41 as permitted sender) smtp.mail=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 Signed-off-by: Mike Holmes Reviewed-by: Taras Kondratiuk --- api_guide_lines.dox | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api_guide_lines.dox b/api_guide_lines.dox index be23e9a..4cfe088 100644 --- a/api_guide_lines.dox +++ b/api_guide_lines.dox @@ -144,6 +144,11 @@ The values !0 = true, 0 = false are used for this purpose. Pass indications are integers (int) and SHOULD also be used for APIs that return a simple success/failure indication to the caller. In this case the return value 0 indicates success while non-zero (typically -1) indicates failure and errno is set to a reason code that indicates the nature of the failure. +@subsection odp_internal Internal APIs +When an interface is defined in a header file and is intended to to be reused internally it will follow these rules:- +- Be prefixed with an underscore "_". +- All the required definitions for the API are to use an underscore, this includes MACROS, typedefs, enums and function names. + @section implementation Implementation Considerations To support application portability and preserve implementation flexibility, ODP APIs MUST be designed with several guiding principles in mind.