From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 7A7805F17 for ; Thu, 25 Oct 2018 22:33:54 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 116BB21C79; Thu, 25 Oct 2018 16:33:54 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Thu, 25 Oct 2018 16:33:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=mesmtp; bh=ty9G1z7zUTeFH3h6W2J/8g4r8i7dXp9IjR1rtsReGWY=; b=Vg/CAe3/ejT9 bh5MdYlVYT61EA3b7LpQxa8QLsEHzz0ri6xFwMZv4S7WMEQdOglFxzhju1n10BWv Q+7RNjSWHF4bkK6jjkisB3fdBOefUriTD8s2qiz9x23HzknlMP9Y5OXLw8BB6E4D r8kHVbcJhUN033DsVxBLIb0zKlW5oCs= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=ty9G1z7zUTeFH3h6W2J/8g4r8i7dXp9IjR1rtsReG WY=; b=qGJzOzeTCu0HuBqfIrBrWjL9iLXGYd+t9NcfwDQjCh37L23IdMZZFJ6j7 Fwr64rt0E2pJE0x4WOOD8m65wVsWTQ6/J3+imocM7vRHgwKEr75K9F5qad/oCsHd EBts/+hhf2k+XMTSfCi+Tfo56CIM9SJO2LB+uicU7niQIsbPNFQjFdg3wimQqmay Qc33mbKBBMAvxx0jT/JOFSaXDgjPnBr4BSEoMTkiLfB6zuj5idT21FjSQxTPa4gi bhyNV+TS00URJPT+6zpHCwChG9LGOFM6HzCXtL1JZSiSnNSa3xwFoGluzHVgdiBo jG8y2lGCTFAFX+meMLLPrIpFUa/8g== X-ME-Sender: X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 10DBDE455C; Thu, 25 Oct 2018 16:33:51 -0400 (EDT) From: Thomas Monjalon To: Kevin Laatz Cc: dev@dpdk.org, harry.van.haaren@intel.com, stephen@networkplumber.org, gaetan.rivet@6wind.com, shreyansh.jain@nxp.com, mattias.ronnblom@ericsson.com, bruce.richardson@intel.com, Ciara Power , Brian Archbold Date: Thu, 25 Oct 2018 22:33:55 +0200 Message-ID: <2602214.kUTQebeEF6@xps> In-Reply-To: <20181024160311.85457-4-kevin.laatz@intel.com> References: <20181024132725.5142-1-kevin.laatz@intel.com> <20181024160311.85457-1-kevin.laatz@intel.com> <20181024160311.85457-4-kevin.laatz@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v8 03/13] telemetry: initial telemetry infrastructure 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: , X-List-Received-Date: Thu, 25 Oct 2018 20:33:54 -0000 We forgot to add rte_telemetry.h in doxygen: doc/api/doxy-api-index.md doc/api/doxy-api.conf.in We need a section @file at the top of the header file to make it appear in doxygen. 24/10/2018 18:03, Kevin Laatz: > --- /dev/null > +++ b/lib/librte_telemetry/rte_telemetry.h > @@ -0,0 +1,42 @@ > +/* SPDX-License-Identifier: BSD-3-Clause > + * Copyright(c) 2018 Intel Corporation > + */ > + > +#include > + > +#ifndef _RTE_TELEMETRY_H_ > +#define _RTE_TELEMETRY_H_ > + > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Initialize Telemetry > + * > + * @return > + * 0 on successful initialisation. > + * @return > + * -ENOMEM on memory allocation error > + * @return > + * -EPERM on unknown error failure > + * @return > + * -EALREADY if Telemetry is already initialised. > + */ > +int32_t __rte_experimental > +rte_telemetry_init(void); > + > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Clean up and free memory. > + * > + * @return > + * 0 on success > + * @return > + * -EPERM on failure > + */ > +int32_t __rte_experimental > +rte_telemetry_cleanup(void); > + > +#endif