From patchwork Tue Jan 5 21:59:24 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 59209 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp6223503lbb; Tue, 5 Jan 2016 13:59:39 -0800 (PST) X-Received: by 10.140.92.215 with SMTP id b81mr114439110qge.44.1452031179583; Tue, 05 Jan 2016 13:59:39 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id t6si4423491qge.108.2016.01.05.13.59.38; Tue, 05 Jan 2016 13:59:39 -0800 (PST) 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; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id BD3A961794; Tue, 5 Jan 2016 21:59:38 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=SSNR8HPf; dkim-adsp=none (unprotected policy); dkim-atps=neutral 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.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2,T_DKIM_INVALID,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 44FAE61794; Tue, 5 Jan 2016 21:59:34 +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 0DA43617A4; Tue, 5 Jan 2016 21:59:32 +0000 (UTC) Received: from mail-qg0-f43.google.com (mail-qg0-f43.google.com [209.85.192.43]) by lists.linaro.org (Postfix) with ESMTPS id 3BFC9616FC for ; Tue, 5 Jan 2016 21:59:31 +0000 (UTC) Received: by mail-qg0-f43.google.com with SMTP id 6so211224889qgy.1 for ; Tue, 05 Jan 2016 13:59:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:mime-version:content-type :content-transfer-encoding; bh=cbRkC+pXA/V6A0rNKwAYiY3timRsLiU2Ro5QKuDuehs=; b=SSNR8HPfui3RhGEd0FTWwnip+D/l8pGM4/IlXKobeSlE3xHERyU5TUiEh195OKt/sl 62oczeB+pwl9qCjTnqQQ1ih4GFwNMHidwq9EEG0wOV97jyl8pn3sI8Q+ujPOzf03Qet9 /dR7UhxXE9sDcgnjMySEdSWndyA3iIEI5VCH8= 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:mime-version :content-type:content-transfer-encoding; bh=cbRkC+pXA/V6A0rNKwAYiY3timRsLiU2Ro5QKuDuehs=; b=gGmEVzAza8Cs7LrVI2h/tYzOQ+i3v2jx6jek8dGYZNWLR571JefNF8sXUwmjuv6G7G LtnrcXVtVC5LpA8hstpWmytuPYkJRGm5cyfVGC+UhskXMpuYRd5M1MXntmn/Nwd/3m+G kwPtSp9SOeoEzd3i7FCARLhdVseTViAIEIeSYCc1Jd/Vuqvw6W0ihQd9agnvw4iko4cR wyqwN34bNfYISzdJOCXSw6bYQ7ZIjf0Kjb53lBaFXyx/PdU+hje2LBZsanKFIZdewv5H Z/GL+LrnGR7Kt+Y2tcq9DjKtk4g087i9O9n1q7aZOLTqxI1VWqcLjCJtQPKXWjF+vzG/ VH9g== X-Gm-Message-State: ALoCoQmeyxfAiweN46U+xcf6IKxk+5xY3H+gV1k/05poT1HWnPo6NV1QRcpVPG38+fPILUE2PeyI39WMi2NvR21MrW2SNdhAaw== X-Received: by 10.140.92.147 with SMTP id b19mr122767902qge.104.1452031171020; Tue, 05 Jan 2016 13:59:31 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id t1sm43102202qki.44.2016.01.05.13.59.30 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 05 Jan 2016 13:59:30 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 5 Jan 2016 16:59:24 -0500 Message-Id: <1452031164-28504-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 MIME-Version: 1.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: implementers: use callouts 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" Using callouts relates the diagram to the text much more effectively in the finished document Signed-off-by: Mike Holmes --- doc/implementers-guide/implementers-guide.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index 8964b0c..b9f865b 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -22,19 +22,19 @@ tree, but leave the actual definitions to be defined by the specific platform. ./ ├── include/ │   ├── odp/ -│   │   └── api/ +│   │   └── api/ <1> │   │   └── The Public API and the documentation. │   │ -│   └── odp.h This file should be the only file included by the application. +│   └── odp.h <4> This file should be the only file included by the application. │ ├── platform/ │   ├── / │   │   ├── include/ -│   │   │   ├── odp/ +│   │   │   ├── odp/ <2> │   │   │   │   ├── In-line function definitions of the public API for this │   │   │   │ │ platform seen by the application. │   │   │   │ │ -│   │   │   │   └── plat/ +│   │   │   │   └── plat/ <3> │   │   │   │     └── Platform specific types, enums etc as seen by the │   │   │   │ application but require overriding by the │   │   │   │ implementation. @@ -42,16 +42,16 @@ tree, but leave the actual definitions to be defined by the specific platform. │   │   │   └── Internal header files seen only by the implementation. ---- -The doxygen description of the API definition is held in the public api file +<1> The doxygen description of the API definition is held in the public api file 'include/odp/api'. -This file is included by a counterpart in +<2> The public file is included by a counterpart in 'platform//include/odp'. The include of the public API is AFTER the platform specific definitions to allow the platform to provide definitions that match the underlying hardware. -The implementation code includes 'platform//include/plat' +<3> The implementation code includes 'platform//include/plat' and this then provides the source files with a complete definition the ODP API to be implemented. -Applications in turn include the include/odp.h file which includes the +<4> Applications in turn include the include/odp.h file which includes the 'platform//include/plat' files to provide a complete definition of the API.