From patchwork Mon Jun 13 19:37:34 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 69938 Delivered-To: patch@linaro.org Received: by 10.140.106.246 with SMTP id e109csp1705594qgf; Mon, 13 Jun 2016 12:39:59 -0700 (PDT) X-Received: by 10.233.221.130 with SMTP id r124mr11257909qkf.19.1465846799595; Mon, 13 Jun 2016 12:39:59 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x7si16096294qhe.75.2016.06.13.12.39.59; Mon, 13 Jun 2016 12:39:59 -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 486166858E; Mon, 13 Jun 2016 19:39:59 +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 F1EDC68592; Mon, 13 Jun 2016 19:39:32 +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 206D36858E; Mon, 13 Jun 2016 19:39:27 +0000 (UTC) Received: from mail-qg0-f45.google.com (mail-qg0-f45.google.com [209.85.192.45]) by lists.linaro.org (Postfix) with ESMTPS id 80ABB6858D for ; Mon, 13 Jun 2016 19:39:25 +0000 (UTC) Received: by mail-qg0-f45.google.com with SMTP id p34so74043787qgp.1 for ; Mon, 13 Jun 2016 12:39:25 -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=0QBJ+Zjt7bV0bqXrH1SJhgudpV2neu9hpstrNrdoGSI=; b=Im93j7fJm5e7Jt3Y0OjRysi0FmmNGq6k8fwr0aLhPJtuQFJqiEKBQk5+lv4KaIXzRj Q/UoCH2OWg96rzQfwrf2700g29R5rBe/qLRelPqimDamxveusJIvJ01MLFvKYY+M0nyO Rt00D5XogkoKdH4jeQdFPVDijk5EcPspppwDSninTB5vdKiYSxIuzKUjJaPrwmAQ113n VqXGlCeGGK/ptBgUM0/n7aulV86xVe69Qr3YHrc1OF1L9VdT6Ag/WFLOQXmtg/aER+33 kbxQfVe5E58u5BB3N1KyI8b2seXnOpzq148iZ4124syTQRh1B6BfkQovuUtgMheGJySX fE+g== X-Gm-Message-State: ALyK8tLGa4U40ifP9G0qv79OzczJEsHhNOlFRiVy28M0k0txjPnQZKwdL//8b+WxQeKYCHDt3PA= X-Received: by 10.140.237.79 with SMTP id i76mr16943119qhc.43.1465846765203; Mon, 13 Jun 2016 12:39:25 -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 g11sm7255217qhc.39.2016.06.13.12.39.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 13 Jun 2016 12:39:24 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 13 Jun 2016 15:37:34 -0400 Message-Id: <1465846654-13389-2-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1465846654-13389-1-git-send-email-mike.holmes@linaro.org> References: <1465846654-13389-1-git-send-email-mike.holmes@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH v4 2/2] doc: separate pure API guide and implementation guide 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" It should be possible to generate the pure API specification guide, this patch achieves that Copy the application guide to form a platform specific guide. The application guide is now ONLY the public specification. The new platform guide includes the additional definitions specific to odp-linux and it can contain platform specific notes and other documentation as needed Signed-off-by: Mike Holmes --- v4 Subject change from Christophe Bug fixes uncovered in better testing - prior patch Christophe, I dropped your review because I had changed a few things. I moved the common doxygen up a level for one. configure.ac | 4 ++- doc/Doxyfile_common | 32 ++++++++++++++++++++++++ doc/Makefile.am | 5 ++-- doc/application-api-guide/Doxyfile | 50 ++++++-------------------------------- doc/m4/configure.m4 | 1 + doc/platform-api-guide/.gitignore | 1 + doc/platform-api-guide/Doxyfile | 19 +++++++++++++++ doc/platform-api-guide/Makefile.am | 5 ++++ 8 files changed, 71 insertions(+), 46 deletions(-) create mode 100644 doc/Doxyfile_common create mode 100644 doc/platform-api-guide/.gitignore create mode 100644 doc/platform-api-guide/Doxyfile create mode 100644 doc/platform-api-guide/Makefile.am diff --git a/configure.ac b/configure.ac index a12f984..da08d39 100644 --- a/configure.ac +++ b/configure.ac @@ -183,7 +183,9 @@ 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) + ${builddir}/doc/helper-guide/output, + ${srcdir}/doc/platform-api-guide/Doxyfile, + ${builddir}/doc/platform-api-guide/output) ########################################################################## # Enable/disable ODP_DEBUG_PRINT diff --git a/doc/Doxyfile_common b/doc/Doxyfile_common new file mode 100644 index 0000000..5955853 --- /dev/null +++ b/doc/Doxyfile_common @@ -0,0 +1,32 @@ +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 +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 +INTERNAL_DOCS = YES +DOT_IMAGE_FORMAT = svg diff --git a/doc/Makefile.am b/doc/Makefile.am index cf67c42..d49d84b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = application-api-guide helper-guide +SUBDIRS = application-api-guide helper-guide platform-api-guide if user_guide SUBDIRS += implementers-guide users-guide process-guide @@ -7,4 +7,5 @@ endif EXTRA_DIST = \ $(top_srcdir)/doc/doxygenlayout.xml \ $(top_srcdir)/doc/odpdoxygen.css \ - $(top_srcdir)/doc/glossary.adoc + $(top_srcdir)/doc/glossary.adoc \ + $(top_srcdir)/doc/Doxyfile_common diff --git a/doc/application-api-guide/Doxyfile b/doc/application-api-guide/Doxyfile index 97731b2..9cb183c 100644 --- a/doc/application-api-guide/Doxyfile +++ b/doc/application-api-guide/Doxyfile @@ -1,48 +1,12 @@ -PROJECT_NAME = "API Reference Manual for $(WITH_PLATFORM)" +@INCLUDE = $(SRCDIR)/doc/Doxyfile_common + +PROJECT_NAME = "API Reference Manual" 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/application-api-guide \ - $(SRCDIR)/include \ - $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) -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_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) -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 + $(SRCDIR)/include +EXCLUDE_PATTERNS = drv* odp_drv.h +EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR) 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 +WARNINGS = NO diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 index 183c929..ed9451d 100644 --- a/doc/m4/configure.m4 +++ b/doc/m4/configure.m4 @@ -40,5 +40,6 @@ AC_CONFIG_FILES([doc/application-api-guide/Makefile doc/helper-guide/Makefile doc/implementers-guide/Makefile doc/Makefile + doc/platform-api-guide/Makefile doc/process-guide/Makefile doc/users-guide/Makefile]) diff --git a/doc/platform-api-guide/.gitignore b/doc/platform-api-guide/.gitignore new file mode 100644 index 0000000..53752db --- /dev/null +++ b/doc/platform-api-guide/.gitignore @@ -0,0 +1 @@ +output diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile new file mode 100644 index 0000000..b87b7b2 --- /dev/null +++ b/doc/platform-api-guide/Doxyfile @@ -0,0 +1,19 @@ +@INCLUDE = $(SRCDIR)/doc/Doxyfile_common + +PROJECT_NAME = "API Reference Manual for $(WITH_PLATFORM)" +PROJECT_NUMBER = $(VERSION) +PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg +INPUT = $(SRCDIR)/doc/application-api-guide \ + $(SRCDIR)/doc/platform-api-guide \ + $(SRCDIR)/include \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) +EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) +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" diff --git a/doc/platform-api-guide/Makefile.am b/doc/platform-api-guide/Makefile.am new file mode 100644 index 0000000..a04c254 --- /dev/null +++ b/doc/platform-api-guide/Makefile.am @@ -0,0 +1,5 @@ +EXTRA_DIST = \ + Doxyfile + +clean-local: + rm -rf output