From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B424AA04BC; Fri, 9 Oct 2020 09:16:08 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 8E5D61C114; Fri, 9 Oct 2020 09:16:07 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by dpdk.org (Postfix) with ESMTP id CEA961C0DC for ; Fri, 9 Oct 2020 09:16:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602227763; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=qqV6FkBLr/hg7nsq+H2TLQFnBZx924gNTN24kLsW+04=; b=PC/h/pAncWC3+wr+ByyH0ZrC3YqxwtxL21ymHQoLNZCrW5ka6kJtgdQQtRXPy8MW2PoYoB yZ5YlTcOlVnutunDP1ilQUqR82Hrm5GvcQvIOitPnHB+LUfFrDcC2BERv/apYzzl2SJjxv I88zWExi8ZATEzFBQ1RgUya3A7otZ7w= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-275-40c6JJVIO0e7M3oUYjZFoA-1; Fri, 09 Oct 2020 03:16:01 -0400 X-MC-Unique: 40c6JJVIO0e7M3oUYjZFoA-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 378AB802B51; Fri, 9 Oct 2020 07:16:00 +0000 (UTC) Received: from dmarchan.remote.csb (unknown [10.40.193.146]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3E6275D9E8; Fri, 9 Oct 2020 07:15:58 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: stable@dpdk.org, Vipin Varghese , Harry van Haaren Date: Fri, 9 Oct 2020 09:15:54 +0200 Message-Id: <20201009071554.30510-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=david.marchand@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" Subject: [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup 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" Align rte_eal_cleanup return codes description to the rest of dpdk. Fixes: aec9c13c5257 ("eal: add function to release internal resources") Cc: stable@dpdk.org Signed-off-by: David Marchand --- lib/librte_eal/include/rte_eal.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/librte_eal/include/rte_eal.h b/lib/librte_eal/include/rte_eal.h index ddcf6a2e7a..e3c2ef185e 100644 --- a/lib/librte_eal/include/rte_eal.h +++ b/lib/librte_eal/include/rte_eal.h @@ -130,8 +130,9 @@ int rte_eal_init(int argc, char **argv); * be made. It is expected that common usage of this function is to call it * just before terminating the process. * - * @return 0 Successfully released all internal EAL resources - * @return -EFAULT There was an error in releasing all resources. + * @return + * - 0 Successfully released all internal EAL resources. + * - -EFAULT There was an error in releasing all resources. */ int rte_eal_cleanup(void); -- 2.23.0