From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id BD8B942C82; Mon, 19 Jun 2023 09:37:25 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3CAD5410D7; Mon, 19 Jun 2023 09:37:25 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 01F38410D3 for ; Mon, 19 Jun 2023 09:37:23 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1687160243; 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: in-reply-to:in-reply-to:references:references; bh=lreZ9Lm5ryIJIXmIZj+hkwVRYSgLSr/i3RZsebQPi6M=; b=KXKpnzUucfwNJsFCQUGaLylCvOrLeFAj6sjjS8Rw73G5D6izMNi05H4nQscQQHb8Ii3iMb P1dcyY1Do/Yc7BAZhikA0095tAHQk8R93sm+nsnAF9TpNX6ws/zkH5oPaaKYWIYDIbXaQc d+Al3BSAE/guCIPyRowTu4bqecQNUp8= Received: from mail-pj1-f71.google.com (mail-pj1-f71.google.com [209.85.216.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-281-iakK0YOdOkCyUjbkj1z1vQ-1; Mon, 19 Jun 2023 03:37:21 -0400 X-MC-Unique: iakK0YOdOkCyUjbkj1z1vQ-1 Received: by mail-pj1-f71.google.com with SMTP id 98e67ed59e1d1-25ea9bc1705so2721451a91.0 for ; Mon, 19 Jun 2023 00:37:21 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687160240; x=1689752240; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=lreZ9Lm5ryIJIXmIZj+hkwVRYSgLSr/i3RZsebQPi6M=; b=U5c0x4RtyjAEdoDR7TUV91aXjM5pf7wAmiJy843IVtVPrMggtxH6BwvrvY++6X2VhL hY3ZGbSrsr7q00o9xubrRthT3tgs1vPMwfCPdPb2Rf5f/trtqw1mBFSHfBFHsSJylb5B AegebTc6H193QXt0o3xBezdwP1cjt8stet4Wshf1h2LCn6vYHq6f0PBnYOi7t1v9crwF DVBsztgM6dRDdF2PlSMxpflOZiU5F/hQyn9/iAma6aHIZLdKSbEKs3hhb+WDG3rbm137 CXjgFIa0Be36JS3mbQsXOvnPAM5JmHwl3GnNH8wCPphePJ4ZxcJODb1UoVO2WZf64pyP P0qw== X-Gm-Message-State: AC+VfDxqLygQDNi5Kr+EE0DgZ9gs/gM+j3UVYnJSp6JWa+HKQXwQlHg8 JkrBIyFAMBKBtCcM/Oz55dukX6291Uog0dSiEBhNvdlmkZSQUnyuRIfM0sRgpCRz5SKgmdwmLDe Pu5JuHBo4e5829qr2oTc= X-Received: by 2002:a17:90a:9705:b0:259:82e:c1d1 with SMTP id x5-20020a17090a970500b00259082ec1d1mr9886025pjo.34.1687160240737; Mon, 19 Jun 2023 00:37:20 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4vQS4iEjEjflCoVIAVm2aiyblPpTVBhudKPkp5ScPgxINMaxD8tKd6ubWSdPqtBZ/J4dCrNf/fIHc4opu/sfE= X-Received: by 2002:a17:90a:9705:b0:259:82e:c1d1 with SMTP id x5-20020a17090a970500b00259082ec1d1mr9886011pjo.34.1687160240460; Mon, 19 Jun 2023 00:37:20 -0700 (PDT) MIME-Version: 1.0 References: <20230615134942.3393383-1-david.marchand@redhat.com> In-Reply-To: From: David Marchand Date: Mon, 19 Jun 2023 09:37:09 +0200 Message-ID: Subject: Re: [PATCH] mbuf: fix doxygen for distributor metadata To: Bruce Richardson Cc: dev@dpdk.org, stable@dpdk.org, Olivier Matz , Dekel Peled , Andrew Rybchenko X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Thu, Jun 15, 2023 at 5:15=E2=80=AFPM Bruce Richardson wrote: > > On Thu, Jun 15, 2023 at 03:49:42PM +0200, David Marchand wrote: > > /**< is for post annotations. > > > > Fixes: 839b20be0e9b ("ethdev: support metadata as flow rule criteria") > > Cc: stable@dpdk.org > > > > Signed-off-by: David Marchand > > --- > > lib/mbuf/rte_mbuf_core.h | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/lib/mbuf/rte_mbuf_core.h b/lib/mbuf/rte_mbuf_core.h > > index c692c33ec4..2030b3bef9 100644 > > --- a/lib/mbuf/rte_mbuf_core.h > > +++ b/lib/mbuf/rte_mbuf_core.h > > @@ -584,8 +584,8 @@ struct rte_mbuf { > > * @see rte_event_eth_tx_adapter_txq_set(= ) > > */ > > } txadapter; /**< Eventdev ethdev Tx adapter */ > > - /**< User defined tags. See rte_distributor_proce= ss() */ > > uint32_t usr; > > + /**< User defined tags. See rte_distributor_proce= ss() */ > > Yes, this fixes the issue, but... > I dislike having the comment on the line under the item in question. I > think the post-annotation comments should only be used for comments on th= e > same line. If the comment is to be on a different line, I think it should > go on the previous line to the item. I also think this tends to be the > style used throughout DPDK generally. I dislike post annotations (regardless of being on the same line or not) as it is easy to mix the description of fields in a structure. But this file has many other usages of this form and, in doubt, I aligned to them. I can send a followup cleanup if you want, is that ok for you? --=20 David Marchand