From patchwork Mon May 9 20:43:09 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 67372 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp1785926qge; Mon, 9 May 2016 13:45:22 -0700 (PDT) X-Received: by 10.140.29.165 with SMTP id b34mr36900652qgb.100.1462826722585; Mon, 09 May 2016 13:45:22 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id n125si19907179qkf.225.2016.05.09.13.45.19; Mon, 09 May 2016 13:45:22 -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 73896611F3; Mon, 9 May 2016 20:45:19 +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_H2, 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 8538A615C9; Mon, 9 May 2016 20:43:58 +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 CB822610F6; Mon, 9 May 2016 20:43:49 +0000 (UTC) Received: from mail-qg0-f54.google.com (mail-qg0-f54.google.com [209.85.192.54]) by lists.linaro.org (Postfix) with ESMTPS id 20150610F6 for ; Mon, 9 May 2016 20:43:48 +0000 (UTC) Received: by mail-qg0-f54.google.com with SMTP id w36so95660223qge.3 for ; Mon, 09 May 2016 13:43:48 -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:in-reply-to :references; bh=0mNAHAEe+AMzkSvB9Re2yOjJomvvzYvmk7GMwfq6qlM=; b=meG57JAXFfIBPgwMhsgJfkEysS8I7rDlh+H3kvU8qF93kBAhFzhiTVPH23NYampdrQ cdiVV5xjz/9b5MAMs8eijih38izITzIS7+vx+BiHyV8djv/FXrIb/Oup6ZMoETYDQ8sy LKv5m+XBzHeAmn6qcreCVXuyfkKNPOiUaL2kcO/33RYs6UFKMpz84ln1Ir/In0h5dbdz uBv4yBv/GHlvNDQZnVE0LlmPfaUbghSjSs3gsjjzOBlFQGMj50thAnYYdGxh+uLt1wDY IWT7l84sogLKf6Ux9x0iBJFREs1BiZVbSTOtNTyHt72Tt3Cma5mZRQvhhXVqcBWk9vTM N6pg== X-Gm-Message-State: AOPr4FXJDLHBHhQFQX2j6LI1g46ZJwNFG1dEa4ztAdoUinAHETrNxzoOJbD5V0jNvktetsaWnZA= X-Received: by 10.140.130.77 with SMTP id 74mr39254945qhc.27.1462826627872; Mon, 09 May 2016 13:43:47 -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 w16sm12626912qka.35.2016.05.09.13.43.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 09 May 2016 13:43:47 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 9 May 2016 16:43:09 -0400 Message-Id: <1462826592-24895-5-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1462826592-24895-1-git-send-email-mike.holmes@linaro.org> References: <1462826592-24895-1-git-send-email-mike.holmes@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 5/8] doc: helper guide: add initial version 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: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Mike Holmes --- configure.ac | 6 +++++- doc/Makefile.am | 2 +- doc/helper-guide/.gitignore | 1 + doc/helper-guide/Doxyfile | 45 ++++++++++++++++++++++++++++++++++++++++++++ doc/helper-guide/Makefile.am | 6 ++++++ doc/helper-guide/odp.dox | 26 +++++++++++++++++++++++++ doc/m4/configure.m4 | 1 + 7 files changed, 85 insertions(+), 2 deletions(-) create mode 100644 doc/helper-guide/.gitignore create mode 100644 doc/helper-guide/Doxyfile create mode 100644 doc/helper-guide/Makefile.am create mode 100644 doc/helper-guide/odp.dox diff --git a/configure.ac b/configure.ac index 8ca95c1..88abe16 100644 --- a/configure.ac +++ b/configure.ac @@ -153,7 +153,11 @@ AM_CONDITIONAL([HAVE_MSCGEN], [test "x${MSCGEN}" = "xmscgen"]) DX_HTML_FEATURE(ON) DX_PDF_FEATURE(OFF) DX_PS_FEATURE(OFF) -DX_INIT_DOXYGEN($PACKAGE_NAME, ${srcdir}/doc/application-api-guide/Doxyfile, ${builddir}/doc/application-api-guide/output) +DX_INIT_DOXYGEN($PACKAGE_NAME, + ${srcdir}/doc/application-api-guide/Doxyfile, + ${builddir}/doc/application-api-guide/output, + ${srcdir}/doc/helper-guide/Doxyfile, + ${builddir}/doc/helper-guide/output) ########################################################################## # Enable/disable ODP_DEBUG_PRINT diff --git a/doc/Makefile.am b/doc/Makefile.am index e966e95..c10ce63 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = application-api-guide +SUBDIRS = application-api-guide helper-guide if user_guide SUBDIRS += implementers-guide users-guide process-guide diff --git a/doc/helper-guide/.gitignore b/doc/helper-guide/.gitignore new file mode 100644 index 0000000..53752db --- /dev/null +++ b/doc/helper-guide/.gitignore @@ -0,0 +1 @@ +output diff --git a/doc/helper-guide/Doxyfile b/doc/helper-guide/Doxyfile new file mode 100644 index 0000000..bcc2453 --- /dev/null +++ b/doc/helper-guide/Doxyfile @@ -0,0 +1,45 @@ +PROJECT_NAME = "Helper Reference Manual for $(WITH_PLATFORM)" +PROJECT_NUMBER = $(VERSION) +PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg +QUIET = YES +OUTPUT_DIRECTORY = $(DOCDIR) +FULL_PATH_NAMES = NO +JAVADOC_AUTOBRIEF = YES +OPTIMIZE_OUTPUT_FOR_C = YES +TYPEDEF_HIDES_STRUCT = NO +EXTRACT_STATIC = YES +SORT_MEMBER_DOCS = NO +WARN_NO_PARAMDOC = YES +INPUT = $(SRCDIR)/doc/helper-guide \ + $(SRCDIR)/helper/include +FILE_PATTERNS = *.h odp*.c *.dox +RECURSIVE = YES +SOURCE_BROWSER = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +ALPHABETICAL_INDEX = NO +QHP_NAMESPACE = +GENERATE_TREEVIEW = YES +PAPER_TYPE = a4wide +CLASS_DIAGRAMS = NO +HAVE_DOT = YES +CALL_GRAPH = YES +DOT_MULTI_TARGETS = NO +EXAMPLE_PATTERNS = *.c +EXAMPLE_RECURSIVE = YES +IMAGE_PATH = $(SRCDIR)/doc/images +HTML_EXTRA_STYLESHEET = $(SRCDIR)/doc/odpdoxygen.css +LAYOUT_FILE = $(SRCDIR)/doc/doxygenlayout.xml +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = __GNUC__ \ + __attribute__(x)= \ + ODP_ALIGNED(x)= \ + __BIG_ENDIAN_BITFIELD \ + __LITTLE_ENDIAN_BITFIELD \ + __x86_64__ \ + ODP_PACKED \ + "ODP_HANDLE_T(type)=odp_handle_t type" +INTERNAL_DOCS = YES +DOT_IMAGE_FORMAT = svg diff --git a/doc/helper-guide/Makefile.am b/doc/helper-guide/Makefile.am new file mode 100644 index 0000000..f8d568d --- /dev/null +++ b/doc/helper-guide/Makefile.am @@ -0,0 +1,6 @@ +EXTRA_DIST = \ + odp.dox \ + Doxyfile + +clean-local: + rm -rf output diff --git a/doc/helper-guide/odp.dox b/doc/helper-guide/odp.dox new file mode 100644 index 0000000..0a86d47 --- /dev/null +++ b/doc/helper-guide/odp.dox @@ -0,0 +1,26 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** + * @mainpage + * + * @section sec_1 Introduction + * + * OpenDataPlane (ODP) provides a data plane application programming + * environment that is easy to use, high performance, and portable + * between networking SoCs. + * + * The helper library provides support for commonly used functionality that is + * not directly accelerated by the hardware. + * + * @image html overview.svg + * + * @section contact Contact Details + * - The main web site is http://www.opendataplane.org/ + * - The git repo is https://git.linaro.org/lng/odp.git + * - Bug tracking is https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane + * + */ diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 index 998afe9..183c929 100644 --- a/doc/m4/configure.m4 +++ b/doc/m4/configure.m4 @@ -37,6 +37,7 @@ AC_ARG_ENABLE([user-guides], fi AC_CONFIG_FILES([doc/application-api-guide/Makefile + doc/helper-guide/Makefile doc/implementers-guide/Makefile doc/Makefile doc/process-guide/Makefile