From patchwork Wed Jan 6 12:22:26 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 59237 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp6545644lbb; Wed, 6 Jan 2016 04:22:42 -0800 (PST) X-Received: by 10.141.6.131 with SMTP id i125mr6023993qhd.68.1452082962164; Wed, 06 Jan 2016 04:22:42 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id a78si48386032qgf.66.2016.01.06.04.22.41; Wed, 06 Jan 2016 04:22:42 -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 894E4617A9; Wed, 6 Jan 2016 12:22:41 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=jgfcJCd3; 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 971E6617A9; Wed, 6 Jan 2016 12:22:36 +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 2D553617AA; Wed, 6 Jan 2016 12:22:34 +0000 (UTC) Received: from mail-qg0-f47.google.com (mail-qg0-f47.google.com [209.85.192.47]) by lists.linaro.org (Postfix) with ESMTPS id 0A8FB6179F for ; Wed, 6 Jan 2016 12:22:33 +0000 (UTC) Received: by mail-qg0-f47.google.com with SMTP id b35so170762379qge.0 for ; Wed, 06 Jan 2016 04:22:33 -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; bh=w3uihKfw5sdLvQXC+EY8m080/8ibdqjldB3Yai4xW/g=; b=jgfcJCd3Y51Fac7yu/73KcX/bozwihVa/afc2W6krPNyNeI5+2/Mw9IjPJNXB4dAtE ydx/T3ECKz3Q2AN54pAkGrrePVf+kQd9T8/vraPd3zwYF2RZs6rvlGfrE+vAwrNzzmHk Dc1fcMBCa+Z3ynT+uWDrqwzBRvy/Pt+LIa+H8= 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; bh=w3uihKfw5sdLvQXC+EY8m080/8ibdqjldB3Yai4xW/g=; b=IPBy+3qj8npNRIUr3TPI8uDLDMoz2sKNLAs7ohoskEXweOvM5OLdKSHy33QukI7yi4 ynbaMaBATDVKPNAhwn03GD8TpQ7ZOD0khev9V2tXbBe1Pz42A2Sn7XjXLdJbOESUvGG8 GMLVuYNd04Ws1Z6Tt+Ee8ydV9WtxdAnP5c3VpQ+h8tSJ1QNkMVUl7/DQhl4ZmaRXdxV8 dGYNEFL1aCHzO3AznicdTRDokWwqvgC1FlanXmZ/rf2v1c7lYB145zqGL5U0QPhR0MmN khrJp4SZcJtZ6WNXkxC1l+5NrgC7N3Ldn5Fbt7NVBfBfEh1tpF/yUOaqPBDR3iYwqFvT GhmQ== X-Gm-Message-State: ALoCoQlHgdZz1ZrIkb6iukqF+aeCHNi4Vg/KUc26imBSJwRZlPK9tKTHYKpE4BCpfrgzqxDKGQWlCi879zVafXHzcuykJOySVQ== X-Received: by 10.140.178.139 with SMTP id y133mr132191610qhy.92.1452082952824; Wed, 06 Jan 2016 04:22:32 -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 m52sm44050895qge.20.2016.01.06.04.22.32 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 06 Jan 2016 04:22:32 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 6 Jan 2016 07:22:26 -0500 Message-Id: <1452082946-26822-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: move api docs to application-api-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" The other documentation is contained in its own directory, the API guide for the application should be no different. This also makes way for a possible south-bound API for NIC drivers Signed-off-by: Mike Holmes --- configure.ac | 3 +-- doc/Makefile.am | 7 ------- doc/application-api-guide/Makefile.am | 5 +++++ doc/{ => application-api-guide}/api_guide_lines.dox | 0 doc/{ => application-api-guide}/doxygen.cfg | 0 doc/{ => application-api-guide}/examples.dox | 0 doc/{ => application-api-guide}/odp.dox | 0 doc/{ => application-api-guide}/release.dox | 0 8 files changed, 6 insertions(+), 9 deletions(-) create mode 100644 doc/application-api-guide/Makefile.am rename doc/{ => application-api-guide}/api_guide_lines.dox (100%) rename doc/{ => application-api-guide}/doxygen.cfg (100%) rename doc/{ => application-api-guide}/examples.dox (100%) rename doc/{ => application-api-guide}/odp.dox (100%) rename doc/{ => application-api-guide}/release.dox (100%) diff --git a/configure.ac b/configure.ac index 2626fd7..e4e5dac 100644 --- a/configure.ac +++ b/configure.ac @@ -141,8 +141,7 @@ AC_ARG_ENABLE([cunit_support], ########################################################################## DX_HTML_FEATURE(ON) DX_PDF_FEATURE(ON) -DX_INIT_DOXYGEN($PACKAGE_NAME, doc/doxygen.cfg, doc/output) - +DX_INIT_DOXYGEN($PACKAGE_NAME, doc/application-api-guide/doxygen.cfg, doc/output) ########################################################################## # Enable/disable Unit tests ########################################################################## diff --git a/doc/Makefile.am b/doc/Makefile.am index a1e9903..41d804b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,10 +8,3 @@ endif if user_guide SUBDIRS += implementers-guide users-guide process-guide endif - -EXTRA_DIST = \ - api_guide_lines.dox \ - examples.dox \ - images \ - odp.dox \ - release.dox diff --git a/doc/application-api-guide/Makefile.am b/doc/application-api-guide/Makefile.am new file mode 100644 index 0000000..10f6030 --- /dev/null +++ b/doc/application-api-guide/Makefile.am @@ -0,0 +1,5 @@ +EXTRA_DIST = \ + api_guide_lines.dox \ + examples.dox \ + odp.dox \ + release.dox diff --git a/doc/api_guide_lines.dox b/doc/application-api-guide/api_guide_lines.dox similarity index 100% rename from doc/api_guide_lines.dox rename to doc/application-api-guide/api_guide_lines.dox diff --git a/doc/doxygen.cfg b/doc/application-api-guide/doxygen.cfg similarity index 100% rename from doc/doxygen.cfg rename to doc/application-api-guide/doxygen.cfg diff --git a/doc/examples.dox b/doc/application-api-guide/examples.dox similarity index 100% rename from doc/examples.dox rename to doc/application-api-guide/examples.dox diff --git a/doc/odp.dox b/doc/application-api-guide/odp.dox similarity index 100% rename from doc/odp.dox rename to doc/application-api-guide/odp.dox diff --git a/doc/release.dox b/doc/application-api-guide/release.dox similarity index 100% rename from doc/release.dox rename to doc/application-api-guide/release.dox