From patchwork Fri Jul 10 17:49:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 51045 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id BA2BD2290A for ; Fri, 10 Jul 2015 17:50:48 +0000 (UTC) Received: by lbcjf8 with SMTP id jf8sf1665853lbc.0 for ; Fri, 10 Jul 2015 10:50:47 -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: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=h+3Ha7NHx56XXCEbrlz9GbtFJI1v1uVPmWTNzZyxdeA=; b=KW5c9axNFWA3xrm+eprPYT88EQvBXFwI1LSLHTTEVZNnyWx+A3SpQ9tkx0KfmXTsaO VaxVbrDwgiHB/wEo0ZldIdkwDh1FhfvsjRY6x5XYFcOHkrF26wKJ0vFFevLetiQk3LrM pOuqYHgYFMo/aBws8ryZDrTe0Oqjoler9iPUQES7RYGoJUALqE0O/jYHRntaIDZedLXa TZ53REFb0fNfSGvJxlG34cNy/t7AT6wfzASeJKUU0PccSE0VEwbvbGaZCZq8TLgR/Jwh otVEgbzDHuQ8GE/9L/9vZUb7f52ROtglNRSh9lpPvqC/HqE2iJfCL5n/nW90Tv8teuLG VxMA== X-Gm-Message-State: ALoCoQlzOpP6TVu/mfaOsU0WEveV8QM+fZHjrGiZguG0Wn9VyFGmOb98RpdJ0ftl4pV+AuSdzqt7 X-Received: by 10.194.93.198 with SMTP id cw6mr11426218wjb.3.1436550647703; Fri, 10 Jul 2015 10:50:47 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.4.227 with SMTP id n3ls1325157lan.0.gmail; Fri, 10 Jul 2015 10:50:47 -0700 (PDT) X-Received: by 10.152.21.132 with SMTP id v4mr20697640lae.18.1436550647535; Fri, 10 Jul 2015 10:50:47 -0700 (PDT) Received: from mail-lb0-f176.google.com (mail-lb0-f176.google.com. [209.85.217.176]) by mx.google.com with ESMTPS id rc5si7867567lac.166.2015.07.10.10.50.47 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 10 Jul 2015 10:50:47 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.176 as permitted sender) client-ip=209.85.217.176; Received: by lblf12 with SMTP id f12so27135159lbl.2 for ; Fri, 10 Jul 2015 10:50:47 -0700 (PDT) X-Received: by 10.152.6.69 with SMTP id y5mr20725777lay.72.1436550647255; Fri, 10 Jul 2015 10:50:47 -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.108.230 with SMTP id hn6csp140994lbb; Fri, 10 Jul 2015 10:50:46 -0700 (PDT) X-Received: by 10.140.100.146 with SMTP id s18mr24136765qge.36.1436550645721; Fri, 10 Jul 2015 10:50:45 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id f192si4466396qka.113.2015.07.10.10.50.15; Fri, 10 Jul 2015 10:50:45 -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 69DCC62072; Fri, 10 Jul 2015 17:50:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 34D806200D; Fri, 10 Jul 2015 17:50:12 +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 D95106200D; Fri, 10 Jul 2015 17:50:06 +0000 (UTC) Received: from mail-qg0-f51.google.com (mail-qg0-f51.google.com [209.85.192.51]) by lists.linaro.org (Postfix) with ESMTPS id B4E6461D1A for ; Fri, 10 Jul 2015 17:50:05 +0000 (UTC) Received: by qget71 with SMTP id t71so132594180qge.2 for ; Fri, 10 Jul 2015 10:50:05 -0700 (PDT) X-Received: by 10.140.238.15 with SMTP id j15mr37250523qhc.4.1436550605469; Fri, 10 Jul 2015 10:50:05 -0700 (PDT) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id e64sm5809948qkh.19.2015.07.10.10.50.04 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 10 Jul 2015 10:50:04 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Fri, 10 Jul 2015 13:49:59 -0400 Message-Id: <1436550599-23287-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.4 X-Topics: patch Subject: [lng-odp] [PATCH] doc: api_guide_lines: add structure initialization 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: 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.217.176 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: Bill Fischofer --- doc/api_guide_lines.dox | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index f3f7799..70d6cb8 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -78,6 +78,17 @@ Other mechanisms available to the implementer are: - ODP_DEPRECATED() is used to signify that a call is planned for obsolescence. - ODP_LOG() is used to direct implementation messages to the application. +@subsection structure Structure Initialization +For each structure defined in the ODP API an initialization function is required. +It must take the form odp_init for example:- + +@code +typedef struct odp_foo_t { +... +} odp_foo_t + +void odp_foo_init(odp_foo_t *foo); +@endcode @subsection function_name Function Names Functions must attempt to be so clear in their intent that referencing the documentation is not necessary, the guidelines below should be followed unless a strong case is made for an exception.