docs/xentop: Add documentation for physical CPU monitoring feature

[PATCH] docs/xentop: Add documentation for physical CPU monitoring feature

Posted by Jahan Murudi 5 months, 1 week ago

Add man page documentation for the new '-p/--pcpus' flag that displays
physical CPU utilization metrics. This provides hypervisor-level CPU
usage insights alongside existing domain statistics.

Changes include:
- Add '-p' flag to SYNOPSIS section
- Document '--pcpus' option with description
- Maintain consistency with existing documentation style

Signed-off-by: Jahan Murudi <jahan.murudi.zg@renesas.com>
---
 docs/man/xentop.1.pod | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/man/xentop.1.pod b/docs/man/xentop.1.pod
index 593a484ce7..db64ceb694 100644
--- a/docs/man/xentop.1.pod
+++ b/docs/man/xentop.1.pod
@@ -5,7 +5,7 @@ xentop - displays real-time information about a Xen system and domains
 =head1 SYNOPSIS
 
 B<xentop> [B<-h>] [B<-V>] [B<-d>SECONDS] [B<-n>] [B<-r>] [B<-v>] [B<-f>]
-[B<-b>] [B<-i>ITERATIONS] [B<-z>]
+[B<-b>] [B<-i>ITERATIONS] [B<-z>] [B<-p>]
 
 =head1 DESCRIPTION
 
@@ -61,6 +61,10 @@ maximum number of iterations xentop should produce before ending
 
 display dom0 first, ignoring interactive sorting
 
+=item B<-p>, B<--pcpus>
+
+display physical CPU utilization metrics
+
 =back
 
 =head1 INTERACTIVE COMMANDS
-- 
2.34.1

Re: [PATCH] docs/xentop: Add documentation for physical CPU monitoring feature

Posted by Andrew Cooper 4 months, 2 weeks ago

On 04/09/2025 10:25 am, Jahan Murudi wrote:
> Add man page documentation for the new '-p/--pcpus' flag that displays
> physical CPU utilization metrics. This provides hypervisor-level CPU
> usage insights alongside existing domain statistics.
>
> Changes include:
> - Add '-p' flag to SYNOPSIS section
> - Document '--pcpus' option with description
> - Maintain consistency with existing documentation style
>
> Signed-off-by: Jahan Murudi <jahan.murudi.zg@renesas.com>

Acked-by: Andrew Cooper <andrew.cooper3@citrix.com>

This needs a release ack now for Xen 4.21 (CC Oleksii), but it's a docs
patch for a new feature so ought to be considered.

~Andrew

Re: [PATCH] docs/xentop: Add documentation for physical CPU monitoring feature

Posted by Oleksii Kurochko 4 months, 2 weeks ago

On 9/24/25 5:44 PM, Andrew Cooper wrote:
> On 04/09/2025 10:25 am, Jahan Murudi wrote:
>> Add man page documentation for the new '-p/--pcpus' flag that displays
>> physical CPU utilization metrics. This provides hypervisor-level CPU
>> usage insights alongside existing domain statistics.
>>
>> Changes include:
>> - Add '-p' flag to SYNOPSIS section
>> - Document '--pcpus' option with description
>> - Maintain consistency with existing documentation style
>>
>> Signed-off-by: Jahan Murudi<jahan.murudi.zg@renesas.com>
> Acked-by: Andrew Cooper<andrew.cooper3@citrix.com>
>
> This needs a release ack now for Xen 4.21 (CC Oleksii), but it's a docs
> patch for a new feature so ought to be considered.

It is okay with me to have this docs patch in Xen 4.21:
   Release-Acked-by: Oleksii Kurochko<oleksii.kurochko@gmail.com>

Thanks.

~ Oleksii

RE: [PATCH] docs/xentop: Add documentation for physical CPU monitoring feature

Posted by Jahan Murudi 4 months, 2 weeks ago

Hi Anthony,

Just a gentle reminder regarding the patch that adds man page documentation for the new -p/--pcpus flag in xentop. If everything looks good to you, please feel free to merge it. Otherwise, I'm happy to address any feedback or concerns.

Thanks,
Jahan