Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: KVM: make corrections to halt-polling.rst

Module parameters are in sysfs, not debugfs, so change that.

Remove superfluous "that" following "Note:".
Hyphenate "system-wide" values.
Hyphenate "trade-off".

Don't treat "denial of service" as a verb.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Suraj Jitindar Singh <sjitindarsingh@gmail.com>
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Sean Christopherson <seanjc@google.com>
Cc: kvm@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230612030810.23376-2-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Jonathan Corbet
4c60d499 1954d515

+5 -5
+5 -5
Documentation/virt/kvm/halt-polling.rst
··· 112 112 | | function. | | 113 113 +-----------------------+---------------------------+-------------------------+ 114 114 115 - These module parameters can be set from the debugfs files in: 115 + These module parameters can be set from the sysfs files in: 116 116 117 117 /sys/module/kvm/parameters/ 118 118 119 - Note: that these module parameters are system wide values and are not able to 119 + Note: these module parameters are system-wide values and are not able to 120 120 be tuned on a per vm basis. 121 121 122 122 Any changes to these parameters will be picked up by new and existing vCPUs the ··· 142 142 global max polling interval (halt_poll_ns) then the host will always poll for the 143 143 entire block time and thus cpu utilisation will go to 100%. 144 144 145 - - Halt polling essentially presents a trade off between power usage and latency and 145 + - Halt polling essentially presents a trade-off between power usage and latency and 146 146 the module parameters should be used to tune the affinity for this. Idle cpu time is 147 147 essentially converted to host kernel time with the aim of decreasing latency when 148 148 entering the guest. 149 149 150 150 - Halt polling will only be conducted by the host when no other tasks are runnable on 151 151 that cpu, otherwise the polling will cease immediately and schedule will be invoked to 152 - allow that other task to run. Thus this doesn't allow a guest to denial of service the 153 - cpu. 152 + allow that other task to run. Thus this doesn't allow a guest to cause denial of service 153 + of the cpu.