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 58157A04BC for ; Fri, 9 Oct 2020 09:24:55 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 467591C136; Fri, 9 Oct 2020 09:24:54 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by dpdk.org (Postfix) with ESMTP id 820561C127 for ; Fri, 9 Oct 2020 09:24:50 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602228289; 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: in-reply-to:in-reply-to:references:references; bh=apytDgEonomuVg9ueukNrcKdaaqyqyLnadKGcJyy0ss=; b=AE/A5gjo4UmrrggK9He0S0ytEuOavkKPkRcQz6QBw+Ogr7mdaoNsmT1mVPBreeCES8+7lx rdAl6ks98asKimk0bDrKuzg08EZTnJ7VPiX5MWKhv3EblZQt9TCguT9yTaZv+0Cnae/xID R+BnVPYi7O9k+L+9Kj6i6SRHPedLp5M= Received: from mail-vk1-f198.google.com (mail-vk1-f198.google.com [209.85.221.198]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-32-Jpge6a3yPXiduQNpfzX8SA-1; Fri, 09 Oct 2020 03:24:47 -0400 X-MC-Unique: Jpge6a3yPXiduQNpfzX8SA-1 Received: by mail-vk1-f198.google.com with SMTP id v145so1484581vkv.21 for ; Fri, 09 Oct 2020 00:24:47 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=apytDgEonomuVg9ueukNrcKdaaqyqyLnadKGcJyy0ss=; b=ca2B4lqsXIJcJFB9FQpE1lstZY9OLrbkTGmwzdfVh79UOWjGbke8ZmZuNko2E7DwNY 4ojHrVXE8FV2zpUP6pGMzLGbDL6DN0vnRP48tP54SMaTtZcfNQfH4AFa9bTrJMs47L4u lVCTAqzVUDr+5ms2p5798DrhXhpIq66de5gje7zhW1iFeFAaRlEWa/8RpLfxZx96dwPm pjojvKQy1Ar1mhgAmgsCHBrqNf6ws2qn8uibhA4e1NYj8LrrhA1r1TWTpFND8C9kPnlJ u2UY3nNAN3I0aYCfbRq5TZtbhWHwoltBHkfVeIOy/QGFwv9dajEaquP7uUYr6+BCffcV P5bA== X-Gm-Message-State: AOAM531So0X1pJlxdDepHwU/xjNm0lQ7s6JU+QkwCL1PA8GHgnHZV3xF DE1UNEFkdTmcvwwc4Lyfg2PhLff1QYdWx3+DJpS2+h2CL+wzh2M6tZxlCwqcVnMGWuggKCsrTCc gRpv1nbUBFGnuOVPN/8hK1Rc= X-Received: by 2002:a1f:e905:: with SMTP id g5mr6828138vkh.17.1602228286897; Fri, 09 Oct 2020 00:24:46 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxfwa6QL9A37ujyzC0r2dSFhCi0hMXA+KiKZzrIzSrufGDBjlhdTwRZRKnaZwPacITEPdpaGdLfZ/Ia4pXE8Bg= X-Received: by 2002:a1f:e905:: with SMTP id g5mr6828132vkh.17.1602228286642; Fri, 09 Oct 2020 00:24:46 -0700 (PDT) MIME-Version: 1.0 References: <20201009071554.30510-1-david.marchand@redhat.com> In-Reply-To: <20201009071554.30510-1-david.marchand@redhat.com> From: David Marchand Date: Fri, 9 Oct 2020 09:24:35 +0200 Message-ID: To: Harry van Haaren Cc: dpdk stable , dev , Vipin Varghese Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=dmarchan@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Subject: Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" On Fri, Oct 9, 2020 at 9:16 AM David Marchand wrote: > > 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); > Side note, this function has never returned anything but 0. Is this some stale doxygen comment from the introduction of this function? I wonder what an application could do if the cleanup failed, anyway. EAL will probably have error logs in such a situation? -- David Marchand