Re: [PATCH v2 1/1] Documentation: hyperv: Update documentation for sending VMBus packets

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] docs: hyperv: typo in vmbus.rst 'arrving' instead of 'arriving'
--

commit 3fd30f16ff2564a1edce678567a65e19e411e062
Author: Michael Kelley <mhkelley58@gmail.com>

Documentation: hyperv: Update documentation for sending VMBus packets

The commit updates the VMBus documentation to reflect changes in the sending
functions, specifically the removal of vmbus_sendpacket_pagebuffer(), the
addition of vmbus_sendpacket_getid(), and the updated capability of
vmbus_sendpacket_mpb_desc().

> diff --git a/Documentation/virt/hyperv/vmbus.rst b/Documentation/virt/hyperv/vmbus.rst
> index 654bb48499724..9c5b712c6e397 100644
> --- a/Documentation/virt/hyperv/vmbus.rst
> +++ b/Documentation/virt/hyperv/vmbus.rst
> @@ -141,14 +141,15 @@ Three functions exist to send VMBus channel messages:

[ ... ]

> +2. vmbus_sendpacket_getid(): Similar to vmbus_sendpacket() but returns
> +   a transaction ID that is matched against a reply from the Hyper-V
> +   host. Useful when the struct completion (or other rendezvous data)
> +   must reside on the caller's stack. By invalidating the transaction
> +   ID before exiting the function due to a timeout or other error, a
> +   late arrving interrupt is assured to not trash the stack.

[Severity: Low]
This isn't a bug, but there is a typo here: "arrving" instead of "arriving".

> +3. vmbus_sendpacket_mpb_desc(): Message with one or more data ranges
> +   to target. Each range consists of a single offset and length plus
> +   a list of GPAs that describe a logical area of guest memory.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261009184056.7382-1-mhklinux@outlook.com?part=1