netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Przemek Kitszel <przemyslaw.kitszel@intel.com>
Cc: Tony Nguyen <anthony.l.nguyen@intel.com>,
	intel-wired-lan@lists.osuosl.org, netdev@vger.kernel.org,
	Aleksandr Loktionov <aleksandr.loktionov@intel.com>,
	Andrew Lunn <andrew+netdev@lunn.ch>,
	linux-kernel@vger.kernel.org,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>
Subject: Re: [PATCH net v1 1/1] idpf: Fix kernel-doc descriptions to avoid warnings
Date: Wed, 26 Nov 2025 08:39:41 +0200	[thread overview]
Message-ID: <aSagrR6mxkRexUDe@smile.fi.intel.com> (raw)
In-Reply-To: <abf25d3d-30af-479f-9342-9955ec23d92f@intel.com>

On Wed, Nov 26, 2025 at 07:30:18AM +0100, Przemek Kitszel wrote:
> On 11/24/25 18:42, Andy Shevchenko wrote:
> > In many functions the Return section is missing. Fix kernel-doc
> > descriptions to address that and other warnings.
> > 
> > Before the change:
> > 
> > $ scripts/kernel-doc -none -Wreturn drivers/net/ethernet/intel/idpf/idpf_txrx.c 2>&1 | wc -l
> > 85

> this is small change and leaves the driver good for long future to come
> I think it is net-positive in terms of minor annoyances for rebase or
> backports, so:
> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>

Thank you!

> side note:
> Alex did analogous work for the ice driver, and I stopped him going
> public, as it was counted in thousands lines changes for little benefit
> 
> usual rant about kdoc warnings:
> agghr!!

(And usual rant about warnings in Linux Next unrelated to my code)

Yes, the problem is that there are warnings and, if your tree is in Linux Next,
make Stephen's and others lives easier by not having / producing new ones.

So, please, send fixes for ice as well at some point. It can be just a single
change (in case one wants to backport it). In _long term_ it's much better than
(what is happening with ice case) increasing a technical debt.

-- 
With Best Regards,
Andy Shevchenko



  reply	other threads:[~2025-11-26  6:39 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-24 17:42 [PATCH net v1 1/1] idpf: Fix kernel-doc descriptions to avoid warnings Andy Shevchenko
2025-11-26  6:30 ` Przemek Kitszel
2025-11-26  6:39   ` Andy Shevchenko [this message]
2025-11-26  7:24   ` Loktionov, Aleksandr
2025-11-26  7:53     ` Andy Shevchenko
2025-11-26  8:06       ` Loktionov, Aleksandr
2025-11-26  8:39         ` Andy Shevchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aSagrR6mxkRexUDe@smile.fi.intel.com \
    --to=andriy.shevchenko@linux.intel.com \
    --cc=aleksandr.loktionov@intel.com \
    --cc=andrew+netdev@lunn.ch \
    --cc=anthony.l.nguyen@intel.com \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=intel-wired-lan@lists.osuosl.org \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=przemyslaw.kitszel@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).