Skip to content

Commit 120881b

Browse files
mchehabbonzini
authored andcommitted
docs: virt: guest-halt-polling.txt convert to ReST
Due to some merge conflict, this file ended being alone under Documentation/virtual. The file itself is almost at ReST format. Just minor adjustments are needed: - Adjust title markup; - Adjust a list identation; - add a literal block markup; - Add some blank lines. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 033741c commit 120881b

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

Documentation/virtual/guest-halt-polling.txt renamed to Documentation/virt/guest-halt-polling.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
==================
12
Guest halt polling
23
==================
34

45
The cpuidle_haltpoll driver, with the haltpoll governor, allows
56
the guest vcpus to poll for a specified amount of time before
67
halting.
8+
79
This provides the following benefits to host side polling:
810

911
1) The POLL flag is set while polling is performed, which allows
@@ -29,25 +31,29 @@ Module Parameters
2931
The haltpoll governor has 5 tunable module parameters:
3032

3133
1) guest_halt_poll_ns:
34+
3235
Maximum amount of time, in nanoseconds, that polling is
3336
performed before halting.
3437

3538
Default: 200000
3639

3740
2) guest_halt_poll_shrink:
41+
3842
Division factor used to shrink per-cpu guest_halt_poll_ns when
3943
wakeup event occurs after the global guest_halt_poll_ns.
4044

4145
Default: 2
4246

4347
3) guest_halt_poll_grow:
48+
4449
Multiplication factor used to grow per-cpu guest_halt_poll_ns
4550
when event occurs after per-cpu guest_halt_poll_ns
4651
but before global guest_halt_poll_ns.
4752

4853
Default: 2
4954

5055
4) guest_halt_poll_grow_start:
56+
5157
The per-cpu guest_halt_poll_ns eventually reaches zero
5258
in case of an idle system. This value sets the initial
5359
per-cpu guest_halt_poll_ns when growing. This can
@@ -66,13 +72,13 @@ high once achieves global guest_halt_poll_ns value).
6672

6773
Default: Y
6874

69-
The module parameters can be set from the debugfs files in:
75+
The module parameters can be set from the debugfs files in::
7076

7177
/sys/module/haltpoll/parameters/
7278

7379
Further Notes
7480
=============
7581

7682
- Care should be taken when setting the guest_halt_poll_ns parameter as a
77-
large value has the potential to drive the cpu usage to 100% on a machine which
78-
would be almost entirely idle otherwise.
83+
large value has the potential to drive the cpu usage to 100% on a machine
84+
which would be almost entirely idle otherwise.

Documentation/virt/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Linux Virtualization Support
1010
kvm/index
1111
uml/user_mode_linux
1212
paravirt_ops
13+
guest-halt-polling
1314

1415
.. only:: html and subproject
1516

0 commit comments

Comments
 (0)