public inbox for passt-dev@passt.top
 help / color / mirror / code / Atom feed
From: Stefano Brivio <sbrivio@redhat.com>
To: David Gibson <david@gibson.dropbear.id.au>
Cc: passt-dev@passt.top, Jon Maloy <jmaloy@redhat.com>
Subject: Re: [PATCH v2] tap: Update some function comments for accuracy
Date: Thu, 16 Oct 2025 01:46:24 +0200	[thread overview]
Message-ID: <20251016014624.4e2e9bc8@elisabeth> (raw)
In-Reply-To: <20251012234941.1433683-1-david@gibson.dropbear.id.au>

On Mon, 13 Oct 2025 10:49:41 +1100
David Gibson <david@gibson.dropbear.id.au> wrote:

> Several of the tap_push_*() functions have doc comments claiming they take
> the context pointer, but don't.  Some (tap_push_uh[46]) were broken fairly
> recently, but others (tap_push_ip[46]h) have been broken for a long time.
> 
> Regardless, fix all the doc comments.
> 
> Reported-by: Stefano Brivio <sbrivio@redhat.com>
> Fixes: 82a839be9 ("tap: break out building of udp header from tap_udp4_send function")
> Fixes: 87e6a4644 ("tap: break out building of udp header from tap_udp6_send function")
> Fixes: 2dbc622f5 ("tap: Split tap_ip4_send() into UDP and ICMP variants")
> Fixes: 9d8dd8b6f ("tap: Split tap_ip6_send() into UDP and ICMP variants")
> 
> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>

Applied, with one minor change to tags (I plan to add some stuff,
including this bit, to the new CONTRIBUTING.md).

For consistency with the Linux kernel, we use SHAs abbreviated to 12
digits there, even though 9-digit abbreviations (produced by default
git-publish settings, I guess) are unlikely to ever lead to any
conflict for us.

Well, that's true at least until the day you all discover
https://github.com/not-an-aardvark/lucky-commit, but at that point the
number of digits wouldn't make a difference.

So, to keep the consistency consistent, I changed those to 12-digit
forms and dropped the extra newline (also added by git-publish). If
you fancy a script checking that for you, see:

  https://lore.kernel.org/all/20190220213729.49deb54f@redhat.com/

I pondered about adding that to hooks/, but it feels a bit like
overstepping. And I can "fix" those in seconds anyway (I regularly do,
I'm just pointing it out on this example as it's rather visible here).

-- 
Stefano


  reply	other threads:[~2025-10-15 23:46 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-12 23:49 David Gibson
2025-10-15 23:46 ` Stefano Brivio [this message]
2025-10-16  0:47   ` David Gibson
2025-10-28 23:13     ` Stefano Brivio
2025-10-29  0:25       ` David Gibson

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=20251016014624.4e2e9bc8@elisabeth \
    --to=sbrivio@redhat.com \
    --cc=david@gibson.dropbear.id.au \
    --cc=jmaloy@redhat.com \
    --cc=passt-dev@passt.top \
    /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.
Code repositories for project(s) associated with this public inbox

	https://passt.top/passt

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 IMAP folder(s).