From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.7 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2BCB2C48BD6 for ; Thu, 27 Jun 2019 13:58:29 +0000 (UTC) Received: from dpdk.org (dpdk.org [92.243.14.124]) by mail.kernel.org (Postfix) with ESMTP id DF33D2084B for ; Thu, 27 Jun 2019 13:58:28 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DF33D2084B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=dev-bounces@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7A71D2C30; Thu, 27 Jun 2019 15:58:27 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id D05D92C12 for ; Thu, 27 Jun 2019 15:58:25 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Jun 2019 06:58:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,423,1557212400"; d="scan'208";a="183458172" Received: from silpixa00389822.ir.intel.com (HELO silpixa00389822.ger.corp.intel.com) ([10.237.223.42]) by fmsmga001.fm.intel.com with ESMTP; 27 Jun 2019 06:58:23 -0700 From: "A.McLoughlin" To: dev@dpdk.org Cc: marko.kovacevic@intel.com, john.mcnamara@intel.com, ferruh.yigit@intel.com, "A.McLoughlin" Date: Thu, 27 Jun 2019 14:58:19 +0100 Message-Id: <20190627135819.22175-1-aideen.mcloughlin@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190627134653.21936-1-aideen.mcloughlin@intel.com> References: <20190627134653.21936-1-aideen.mcloughlin@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: add search feature to API doc page X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" I modified the API config file to incorperate a search button into the API documentation page. Signed-off-by: A.McLoughlin --- V2: Adding description for patch --- doc/api/doxy-api.conf.in | 2 +- mk/rte.sdkdoc.mk | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index b9896cb63..20188a42e 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -83,7 +83,7 @@ ALPHABETICAL_INDEX = NO HTML_TIMESTAMP = NO HTML_DYNAMIC_SECTIONS = YES -SEARCHENGINE = NO +SEARCHENGINE = YES SORT_MEMBER_DOCS = NO SOURCE_BROWSER = YES diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index c44db6447..fd77e4186 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -56,6 +56,7 @@ api-html: $(API_EXAMPLES) .PHONY: api-html-clean api-html-clean: $(Q)rm -f $(API_EXAMPLES) + $(Q)rm -rf $(RTE_OUTPUT)/doc/html/api/search $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/* $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true -- 2.17.1 -------------------------------------------------------------- Intel Research and Development Ireland Limited Registered in Ireland Registered Office: Collinstown Industrial Park, Leixlip, County Kildare Registered Number: 308263 This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.