From patchwork Wed Nov 26 20:13:19 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 41564 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f71.google.com (mail-wg0-f71.google.com [74.125.82.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id D1BDD25E80 for ; Wed, 26 Nov 2014 20:13:52 +0000 (UTC) Received: by mail-wg0-f71.google.com with SMTP id l18sf2228568wgh.10 for ; Wed, 26 Nov 2014 12:13:52 -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: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=+SJy819RfYf/KSRx7Kpj1Rl1TMQwv77R29Z1Y0+RyBA=; b=VwnURqsxkezCpY01f/yNedMG+aKWEcEfEjkwdZ9VMsJT4fjRkJK/JLtSrWWmuvwXSP huBnh575QFdIV1LNpW8N002OK92+cjgp+jFdDdRRMbPLeSlgeRkKtUEjXjoSwxJsj56j Ak81nHxHieX1QTNYQWOtWfzqdYQYFJQj1oOaCBl/IcCEzmnybxMR9/X1605hrCq4HOrp V1Hin9JM1PlKh6wcbNnZaHkg2Xr37FmZqUYJgwmNrJXlJLZ8nVpGf8UV/4j91+MoCENN Jb5XANL5VcedW/Opwq5QPAMjibeF7XxXHgH0OnnPl/zW/arsqvmve/+h96a8LhL7o+e/ Kq6g== X-Gm-Message-State: ALoCoQmVz0JzRPXFP+owcZALF5Li1oKdi6KIqRlcLUG4o3woznMUvvYblaBN+XrtKkIOFt7J83ic X-Received: by 10.152.6.133 with SMTP id b5mr22437laa.10.1417032832015; Wed, 26 Nov 2014 12:13:52 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.6.9 with SMTP id w9ls776239law.1.gmail; Wed, 26 Nov 2014 12:13:51 -0800 (PST) X-Received: by 10.152.203.199 with SMTP id ks7mr35661589lac.31.1417032831870; Wed, 26 Nov 2014 12:13:51 -0800 (PST) Received: from mail-la0-f46.google.com (mail-la0-f46.google.com. [209.85.215.46]) by mx.google.com with ESMTPS id xz9si5330801lbb.126.2014.11.26.12.13.51 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 26 Nov 2014 12:13:51 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.46 as permitted sender) client-ip=209.85.215.46; Received: by mail-la0-f46.google.com with SMTP id gd6so3105086lab.19 for ; Wed, 26 Nov 2014 12:13:51 -0800 (PST) X-Received: by 10.152.87.100 with SMTP id w4mr35092461laz.27.1417032831444; Wed, 26 Nov 2014 12:13:51 -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 ew9csp692578lbc; Wed, 26 Nov 2014 12:13:50 -0800 (PST) X-Received: by 10.221.68.199 with SMTP id xz7mr18940292vcb.7.1417032830228; Wed, 26 Nov 2014 12:13:50 -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 xq8si2039171vdc.76.2014.11.26.12.13.48 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 26 Nov 2014 12:13:49 -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 1Xtiy9-0002At-LO; Wed, 26 Nov 2014 20:13:45 +0000 Received: from mail-qa0-f43.google.com ([209.85.216.43]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xtiy3-000274-FM for lng-odp@lists.linaro.org; Wed, 26 Nov 2014 20:13:39 +0000 Received: by mail-qa0-f43.google.com with SMTP id bm13so2462630qab.30 for ; Wed, 26 Nov 2014 12:13:34 -0800 (PST) X-Received: by 10.140.95.225 with SMTP id i88mr47153352qge.2.1417032814185; Wed, 26 Nov 2014 12:13:34 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id a97sm4779190qge.13.2014.11.26.12.13.33 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 26 Nov 2014 12:13:33 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 26 Nov 2014 15:13:19 -0500 Message-Id: <1417032799-38487-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: Architecture patch Subject: [lng-odp] [PATCH 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.46 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 --- api_guide_lines.dox | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/api_guide_lines.dox b/api_guide_lines.dox index be23e9a..1f83c53 100644 --- a/api_guide_lines.dox +++ b/api_guide_lines.dox @@ -144,6 +144,12 @@ 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 "_". +- It may not be placed in include/api. +- 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.