Re: [PATCH v5 13/24] virt/steal_monitor: Add documentation

[Shrikanth Hegde]

Hi Randy, Thanks for checking the patches.

On 6/25/26 10:30 PM, Randy Dunlap wrote:
> Hi,
>
> On 6/25/26 5:46 AM, Shrikanth Hegde wrote:
> > Document this module named steal_monitor and its parameters.
> >
> > Signed-off-by: Shrikanth Hegde <sshegde@xxxxxxxxxxxxx>
> > ---
> > v4-v5:
> > - new patch
> >
> > Please let me know if the placing is not right.
> >
> >   Documentation/driver-api/index.rst         |  1 +
> >   Documentation/driver-api/steal-monitor.rst | 93 ++++++++++++++++++++++
> >   2 files changed, 94 insertions(+)
> >   create mode 100644 Documentation/driver-api/steal-monitor.rst
>
>
> > diff --git a/Documentation/driver-api/steal-monitor.rst b/Documentation/driver-api/steal-monitor.rst
> > new file mode 100644
> > index 000000000000..997a22d0812c
> > --- /dev/null
> > +++ b/Documentation/driver-api/steal-monitor.rst
> > @@ -0,0 +1,93 @@
> > +.. SPDX-License-Identifier: GPL-2.0
> > +=============
> > +Steal Monitor
> > +=============
> > +
> > +:Author: Shrikanth Hegde
> > +
> > +Introduction:
> > +=============
>
> Nit:
> Kernel heading adornment style does not include an ending ':' character
> (4 places).

Ok. I will fix it next version.

> > +
> > +Steal monitor is a driver aimed at solving the Noisy Neighbour problem
> > +in virtualized environments. I.e performance of workload
> > +running in one VM gets affected significantly due to other VMs and
> > +combined they make slower forward progress.