[PATCH] Documentation: update config name in real-time architecture support

[PATCH] Documentation: update config name in real-time architecture support

[Lukas Bulwahn]

From: Lukas Bulwahn <lukas.bulwahn@redhat.com>

Commit 14ec35ff5786 ("entry: Rename "kvm" entry code assets to "virt" to
genericize APIs") renames the config KVM_XFER_TO_GUEST_WORK to
VIRT_XFER_TO_GUEST_WORK. In a concurrent development work with commit
f51fe3b7e48c ("Documentation: Add real-time to core-api"), the
documentation on making an architecture support PREEMPT_RT has been
included referring to this config with its previous name.

Adjust the documentation to the current situation, and specifically
refer to the new name of the config.

Fixes: f51fe3b7e48c ("Documentation: Add real-time to core-api")
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com>
---
 Documentation/core-api/real-time/architecture-porting.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/core-api/real-time/architecture-porting.rst b/Documentation/core-api/real-time/architecture-porting.rst
index d822fac29922..3062cff0e5a3 100644
--- a/Documentation/core-api/real-time/architecture-porting.rst
+++ b/Documentation/core-api/real-time/architecture-porting.rst
@@ -35,9 +35,10 @@ POSIX CPU timers and KVM
   POSIX CPU timers must expire from thread context rather than directly within
   the timer interrupt. This behavior is enabled by setting the configuration
   option CONFIG_HAVE_POSIX_CPU_TIMERS_TASK_WORK.
-  When KVM is enabled, CONFIG_KVM_XFER_TO_GUEST_WORK must also be set to ensure
-  that any pending work, such as POSIX timer expiration, is handled before
-  transitioning into guest mode.
+  When virtualization support, such as KVM, is enabled,
+  CONFIG_VIRT_XFER_TO_GUEST_WORK must also be set to ensure that any pending
+  work, such as POSIX timer expiration, is handled before transitioning into
+  guest mode.
 
 Hard-IRQ and Soft-IRQ stacks
   Soft interrupts are handled in the thread context in which they are raised. If
-- 
2.51.0

Re: [PATCH] Documentation: update config name in real-time architecture support

[Sebastian Andrzej Siewior]

On 2025-09-10 10:58:59 [+0200], Lukas Bulwahn wrote:
> From: Lukas Bulwahn <lukas.bulwahn@redhat.com>
> 
> Commit 14ec35ff5786 ("entry: Rename "kvm" entry code assets to "virt" to
> genericize APIs") renames the config KVM_XFER_TO_GUEST_WORK to

This is 4843a45ef9fe8 ("entry: Rename "kvm" entry code assets to "virt" to genericize APIs")
in -next as of today.

> VIRT_XFER_TO_GUEST_WORK. In a concurrent development work with commit
> f51fe3b7e48c ("Documentation: Add real-time to core-api"), the
> documentation on making an architecture support PREEMPT_RT has been
> included referring to this config with its previous name.
> 
> Adjust the documentation to the current situation, and specifically
> refer to the new name of the config.
> 
> Fixes: f51fe3b7e48c ("Documentation: Add real-time to core-api")
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com>
> ---
>  Documentation/core-api/real-time/architecture-porting.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/core-api/real-time/architecture-porting.rst b/Documentation/core-api/real-time/architecture-porting.rst
> index d822fac29922..3062cff0e5a3 100644
> --- a/Documentation/core-api/real-time/architecture-porting.rst
> +++ b/Documentation/core-api/real-time/architecture-porting.rst
> @@ -35,9 +35,10 @@ POSIX CPU timers and KVM
>    POSIX CPU timers must expire from thread context rather than directly within
>    the timer interrupt. This behavior is enabled by setting the configuration
>    option CONFIG_HAVE_POSIX_CPU_TIMERS_TASK_WORK.
> -  When KVM is enabled, CONFIG_KVM_XFER_TO_GUEST_WORK must also be set to ensure
> -  that any pending work, such as POSIX timer expiration, is handled before
> -  transitioning into guest mode.
> +  When virtualization support, such as KVM, is enabled,
> +  CONFIG_VIRT_XFER_TO_GUEST_WORK must also be set to ensure that any pending
> +  work, such as POSIX timer expiration, is handled before transitioning into
> +  guest mode.

I don't know how this is handled here but if you would start a new line
after "ensure" then you would end up with smaller diff.

>  Hard-IRQ and Soft-IRQ stacks
>    Soft interrupts are handled in the thread context in which they are raised. If

Sebastian