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 4A2D11B3B6 for ; Tue, 9 Oct 2018 02:16:26 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id E0C68220AD; Mon, 8 Oct 2018 20:16:25 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Mon, 08 Oct 2018 20:16:25 -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; s=mesmtp; bh=8NRvayZd3J FATbU2RvxDv1GtboOWjdvOrXUdYjr5CsA=; b=Z88opG/4g8yNg1iZzz/MmJOGsm ho9DgZmhPsZRt+aeylAIKdahDF3xOzBT0PxM/KnIRZ0q9oWoOhAgXeAXi8KkztOf ISTVby3Pn7FvunZvdYrUmsn/9ARM6XbhbgCg7uSIBwyITDG9kKeL/O+xgmlWJndW 36LAczJbArO9U6q64= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding: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= fm3; bh=8NRvayZd3JFATbU2RvxDv1GtboOWjdvOrXUdYjr5CsA=; b=I3qDfS77 muzcCMKQAjPxeJrUNPu6iX8mZ/Y4H8LoQMmKVw2VT6PgbYebfMBVFXDUzBFC0JbD Ejv2tDa6PF5C1HUpa28YzNi4lL7y4t/+SSNMxlmkpeejcdMBSGdYOOoIcXCD64kM A3vJ4bM8yCtHfmzP7QfDp3HzNTXOv9PsRND9ER3ejptG3BpWNZ/ViVbbN3NFAw7g DsRUpdUgG31Ts27JOaytszA+cnYyz171Qu5UNgngRdNYiNiajj5fFRXqwfz8ekkM AgdSX4hQE9VkrNcxO39J2I/3zel42FNhT29XBp6JlpXE7mfLAnuQJZSOaQkZODC9 BCiFCopBHIFC8A== X-ME-Sender: X-ME-Proxy: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id DA0E7102DD; Mon, 8 Oct 2018 20:16:24 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: gaetan.rivet@6wind.com, ophirmu@mellanox.com, ferruh.yigit@intel.com, arybchenko@solarflare.com Date: Tue, 9 Oct 2018 02:16:14 +0200 Message-Id: <20181009001616.10497-5-thomas@monjalon.net> X-Mailer: git-send-email 2.19.0 In-Reply-To: <20181009001616.10497-1-thomas@monjalon.net> References: <20181007222554.4886-1-thomas@monjalon.net> <20181009001616.10497-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 4/6] doc: replace doxygen example in contribution guide 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: Tue, 09 Oct 2018 00:16:26 -0000 The provided example of doxygen header is about a deprecated function. It is replaced by rte_spinlock_trylock() which is small and good enough for the purpose. Signed-off-by: Thomas Monjalon --- doc/guides/contributing/documentation.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index 097575ad7..063c8b6c4 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -615,19 +615,14 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati .. code-block:: c /** - * Attach a new Ethernet device specified by arguments. - * - * @param devargs - * A pointer to a strings array describing the new device - * to be attached. The strings should be a pci address like - * `0000:01:00.0` or **virtual** device name like `net_pcap0`. - * @param port_id - * A pointer to a port identifier actually attached. + * Try to take the lock. * + * @param sl + * A pointer to the spinlock. * @return - * 0 on success and port_id is filled, negative on error. + * 1 if the lock is successfully taken; 0 otherwise. */ - int rte_eth_dev_attach(const char *devargs, uint8_t *port_id); + int rte_spinlock_trylock (rte_spinlock_t *sl); * Doxygen supports Markdown style syntax such as bold, italics, fixed width text and lists. For example the second line in the ``devargs`` parameter in the previous example will be rendered as: -- 2.19.0