€•Hj      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ-/translations/zh_CN/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ-/translations/zh_TW/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ-/translations/it_IT/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ-/translations/ja_JP/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ-/translations/ko_KR/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ-/translations/sp_SP/virt/kvm/review-checklist”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒG/var/lib/git/docbuild/linux/Documentation/virt/kvm/review-checklist.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ Review checklist for kvm patches”h]”hŒ Review checklist for kvm patches”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒoThe patch must follow Documentation/process/coding-style.rst and
Documentation/process/submitting-patches.rst.
”h]”hŒ	paragraph”“”)”}”(hŒnThe patch must follow Documentation/process/coding-style.rst and
Documentation/process/submitting-patches.rst.”h]”hŒnThe patch must follow Documentation/process/coding-style.rst and
Documentation/process/submitting-patches.rst.”…””}”(hhÖhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KhhÐubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ;Patches should be against kvm.git master or next branches.
”h]”hÕ)”}”(hŒ:Patches should be against kvm.git master or next branches.”h]”hŒ:Patches should be against kvm.git master or next branches.”…””}”(hhîhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K
hhêubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ±If the patch introduces or modifies a new userspace API:
- the API must be documented in Documentation/virt/kvm/api.rst
- the API must be discoverable using KVM_CHECK_EXTENSION
”h]”hÕ)”}”(hŒ°If the patch introduces or modifies a new userspace API:
- the API must be documented in Documentation/virt/kvm/api.rst
- the API must be discoverable using KVM_CHECK_EXTENSION”h]”hŒ°If the patch introduces or modifies a new userspace API:
- the API must be documented in Documentation/virt/kvm/api.rst
- the API must be discoverable using KVM_CHECK_EXTENSION”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ1New state must include support for save/restore.
”h]”hÕ)”}”(hŒ0New state must include support for save/restore.”h]”hŒ0New state must include support for save/restore.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ„New features must default to off (userspace should explicitly request them).
Performance improvements can and should default to on.
”h]”hÕ)”}”(hŒƒNew features must default to off (userspace should explicitly request them).
Performance improvements can and should default to on.”h]”hŒƒNew features must default to off (userspace should explicitly request them).
Performance improvements can and should default to on.”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khj2  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒmNew cpu features should be exposed via KVM_GET_SUPPORTED_CPUID2,
or its equivalent for non-x86 architectures
”h]”hÕ)”}”(hŒlNew cpu features should be exposed via KVM_GET_SUPPORTED_CPUID2,
or its equivalent for non-x86 architectures”h]”hŒlNew cpu features should be exposed via KVM_GET_SUPPORTED_CPUID2,
or its equivalent for non-x86 architectures”…””}”(hjN  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KhjJ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ,The feature should be testable (see below).
”h]”hÕ)”}”(hŒ+The feature should be testable (see below).”h]”hŒ+The feature should be testable (see below).”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khjb  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ|Changes should be vendor neutral when possible.  Changes to common code
are better than duplicating changes to vendor code.
”h]”hÕ)”}”(hŒ{Changes should be vendor neutral when possible.  Changes to common code
are better than duplicating changes to vendor code.”h]”hŒ{Changes should be vendor neutral when possible.  Changes to common code
are better than duplicating changes to vendor code.”…””}”(hj~  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khjz  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒPSimilarly, prefer changes to arch independent code than to arch dependent
code.
”h]”hÕ)”}”(hŒOSimilarly, prefer changes to arch independent code than to arch dependent
code.”h]”hŒOSimilarly, prefer changes to arch independent code than to arch dependent
code.”…””}”(hj–  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Khj’  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒ®User/kernel interfaces and guest/host interfaces must be 64-bit clean
(all variables and sizes naturally aligned on 64-bit; use specific types
only - u64 rather than ulong).
”h]”hÕ)”}”(hŒ­User/kernel interfaces and guest/host interfaces must be 64-bit clean
(all variables and sizes naturally aligned on 64-bit; use specific types
only - u64 rather than ulong).”h]”hŒ­User/kernel interfaces and guest/host interfaces must be 64-bit clean
(all variables and sizes naturally aligned on 64-bit; use specific types
only - u64 rather than ulong).”…””}”(hj®  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K hjª  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h NubhÏ)”}”(hŒnNew guest visible features must either be documented in a hardware manual
or be accompanied by documentation.
”h]”hÕ)”}”(hŒmNew guest visible features must either be documented in a hardware manual
or be accompanied by documentation.”h]”hŒmNew guest visible features must either be documented in a hardware manual
or be accompanied by documentation.”…””}”(hjÆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K$hjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÎhhËhžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1hÉhh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒTesting of KVM code”h]”hŒTesting of KVM code”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjå  hžhhŸh³h K(ubhÕ)”}”(hŒÇAll features contributed to KVM, and in many cases bugfixes too, should be
accompanied by some kind of tests and/or enablement in open source guests
and VMMs.  KVM is covered by multiple test suites:”h]”hŒÇAll features contributed to KVM, and in many cases bugfixes too, should be
accompanied by some kind of tests and/or enablement in open source guests
and VMMs.  KVM is covered by multiple test suites:”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K*hjå  hžhubhŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hX8  *Selftests*
These are low level tests that allow granular testing of kernel APIs.
This includes API failure scenarios, invoking APIs after specific
guest instructions, and testing multiple calls to ``KVM_CREATE_VM``
within a single test.  They are included in the kernel tree at
``tools/testing/selftests/kvm``.
”h]”(hŒterm”“”)”}”(hŒ*Selftests*”h]”hŒemphasis”“”)”}”(hj  h]”hŒ	Selftests”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h K3hj  ubhŒ
definition”“”)”}”(hhh]”hÕ)”}”(hX+  These are low level tests that allow granular testing of kernel APIs.
This includes API failure scenarios, invoking APIs after specific
guest instructions, and testing multiple calls to ``KVM_CREATE_VM``
within a single test.  They are included in the kernel tree at
``tools/testing/selftests/kvm``.”h]”(hŒºThese are low level tests that allow granular testing of kernel APIs.
This includes API failure scenarios, invoking APIs after specific
guest instructions, and testing multiple calls to ”…””}”(hj/  hžhhŸNh NubhŒliteral”“”)”}”(hŒ``KVM_CREATE_VM``”h]”hŒKVM_CREATE_VM”…””}”(hj9  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj/  ubhŒ@
within a single test.  They are included in the kernel tree at
”…””}”(hj/  hžhhŸNh Nubj8  )”}”(hŒ``tools/testing/selftests/kvm``”h]”hŒtools/testing/selftests/kvm”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj/  ubhŒ.”…””}”(hj/  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K/hj,  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h K3hj  ubj
  )”}”(hX`  ``kvm-unit-tests``
A collection of small guests that test CPU and emulated device features
from a guest's perspective.  They run under QEMU or ``kvmtool``, and
are generally not KVM-specific: they can be run with any accelerator
that QEMU support or even on bare metal, making it possible to compare
behavior across hypervisors and processor families.
”h]”(j  )”}”(hŒ``kvm-unit-tests``”h]”j8  )”}”(hju  h]”hŒkvm-unit-tests”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h K:hjo  ubj+  )”}”(hhh]”hÕ)”}”(hXL  A collection of small guests that test CPU and emulated device features
from a guest's perspective.  They run under QEMU or ``kvmtool``, and
are generally not KVM-specific: they can be run with any accelerator
that QEMU support or even on bare metal, making it possible to compare
behavior across hypervisors and processor families.”h]”(hŒ~A collection of small guests that test CPU and emulated device features
from a guestâ€™s perspective.  They run under QEMU or ”…””}”(hj  hžhhŸNh Nubj8  )”}”(hŒ``kvmtool``”h]”hŒkvmtool”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj  ubhŒÅ, and
are generally not KVM-specific: they can be run with any accelerator
that QEMU support or even on bare metal, making it possible to compare
behavior across hypervisors and processor families.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K6hjŠ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hjo  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h K:hj  hžhubj
  )”}”(hŒúFunctional test suites
Various sets of functional tests exist, such as QEMU's ``tests/functional``
suite and `avocado-vt <https://avocado-vt.readthedocs.io/en/latest/>`__.
These typically involve running a full operating system in a virtual
machine.
”h]”(j  )”}”(hŒFunctional test suites”h]”hŒFunctional test suites”…””}”(hj½  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h K@hj¹  ubj+  )”}”(hhh]”hÕ)”}”(hŒâVarious sets of functional tests exist, such as QEMU's ``tests/functional``
suite and `avocado-vt <https://avocado-vt.readthedocs.io/en/latest/>`__.
These typically involve running a full operating system in a virtual
machine.”h]”(hŒ9Various sets of functional tests exist, such as QEMUâ€™s ”…””}”(hjÎ  hžhhŸNh Nubj8  )”}”(hŒ``tests/functional``”h]”hŒtests/functional”…””}”(hjÖ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hjÎ  ubhŒ
suite and ”…””}”(hjÎ  hžhhŸNh NubhŒ	reference”“”)”}”(hŒ=`avocado-vt <https://avocado-vt.readthedocs.io/en/latest/>`__”h]”hŒ
avocado-vt”…””}”(hjê  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”Œ
avocado-vt”Œrefuri”Œ,https://avocado-vt.readthedocs.io/en/latest/”uh1jè  hjÎ  ubhŒO.
These typically involve running a full operating system in a virtual
machine.”…””}”(hjÎ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K=hjË  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hj¹  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h K@hj  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  hjå  hžhhŸh³h NubhÕ)”}”(hŒsThe best testing approach depends on the feature's complexity and
operation. Here are some examples and guidelines:”h]”hŒuThe best testing approach depends on the featureâ€™s complexity and
operation. Here are some examples and guidelines:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KBhjå  hžhubj  )”}”(hhh]”(j
  )”}”(hXr  New instructions (no new registers or APIs)
The corresponding CPU features (if applicable) should be made available
in QEMU.  If the instructions require emulation support or other code in
KVM, it is worth adding coverage to ``kvm-unit-tests`` or selftests;
the latter can be a better choice if the instructions relate to an API
that already has good selftest coverage.
”h]”(j  )”}”(hŒ+New instructions (no new registers or APIs)”h]”hŒ+New instructions (no new registers or APIs)”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h KJhj)  ubj+  )”}”(hhh]”hÕ)”}”(hXE  The corresponding CPU features (if applicable) should be made available
in QEMU.  If the instructions require emulation support or other code in
KVM, it is worth adding coverage to ``kvm-unit-tests`` or selftests;
the latter can be a better choice if the instructions relate to an API
that already has good selftest coverage.”h]”(hŒµThe corresponding CPU features (if applicable) should be made available
in QEMU.  If the instructions require emulation support or other code in
KVM, it is worth adding coverage to ”…””}”(hj>  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hjF  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj>  ubhŒ~ or selftests;
the latter can be a better choice if the instructions relate to an API
that already has good selftest coverage.”…””}”(hj>  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KFhj;  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hj)  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h KJhj&  ubj
  )”}”(hX6  New hardware features (new registers, no new APIs)
These should be tested via ``kvm-unit-tests``; this more or less implies
supporting them in QEMU and/or ``kvmtool``.  In some cases selftests
can be used instead, similar to the previous case, or specifically to
test corner cases in guest state save/restore.
”h]”(j  )”}”(hŒ2New hardware features (new registers, no new APIs)”h]”hŒ2New hardware features (new registers, no new APIs)”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h KPhjj  ubj+  )”}”(hhh]”hÕ)”}”(hX  These should be tested via ``kvm-unit-tests``; this more or less implies
supporting them in QEMU and/or ``kvmtool``.  In some cases selftests
can be used instead, similar to the previous case, or specifically to
test corner cases in guest state save/restore.”h]”(hŒThese should be tested via ”…””}”(hj  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj  ubhŒ;; this more or less implies
supporting them in QEMU and/or ”…””}”(hj  hžhhŸNh Nubj8  )”}”(hŒ``kvmtool``”h]”hŒkvmtool”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj  ubhŒ.  In some cases selftests
can be used instead, similar to the previous case, or specifically to
test corner cases in guest state save/restore.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KMhj|  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hjj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h KPhj&  hžhubj
  )”}”(hXµ  Bug fixes and performance improvements
These usually do not introduce new APIs, but it's worth sharing
any benchmarks and tests that will validate your contribution,
ideally in the form of regression tests.  Tests and benchmarks
can be included in either ``kvm-unit-tests`` or selftests, depending
on the specifics of your change.  Selftests are especially useful for
regression tests because they are included directly in Linux's tree.
”h]”(j  )”}”(hŒ&Bug fixes and performance improvements”h]”hŒ&Bug fixes and performance improvements”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h KXhj½  ubj+  )”}”(hhh]”hÕ)”}”(hX  These usually do not introduce new APIs, but it's worth sharing
any benchmarks and tests that will validate your contribution,
ideally in the form of regression tests.  Tests and benchmarks
can be included in either ``kvm-unit-tests`` or selftests, depending
on the specifics of your change.  Selftests are especially useful for
regression tests because they are included directly in Linux's tree.”h]”(hŒÚThese usually do not introduce new APIs, but itâ€™s worth sharing
any benchmarks and tests that will validate your contribution,
ideally in the form of regression tests.  Tests and benchmarks
can be included in either ”…””}”(hjÒ  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hjÚ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hjÒ  ubhŒ¥ or selftests, depending
on the specifics of your change.  Selftests are especially useful for
regression tests because they are included directly in Linuxâ€™s tree.”…””}”(hjÒ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KShjÏ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hj½  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h KXhj&  hžhubj
  )”}”(hXk  Large scale internal changes
While it's difficult to provide a single policy, you should ensure that
the changed code is covered by either ``kvm-unit-tests`` or selftests.
In some cases the affected code is run for any guests and functional
tests suffice.  Explain your testing process in the cover letter,
as that can help identify gaps in existing test suites.
”h]”(j  )”}”(hŒLarge scale internal changes”h]”hŒLarge scale internal changes”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h K_hjþ  ubj+  )”}”(hhh]”hÕ)”}”(hXM  While it's difficult to provide a single policy, you should ensure that
the changed code is covered by either ``kvm-unit-tests`` or selftests.
In some cases the affected code is run for any guests and functional
tests suffice.  Explain your testing process in the cover letter,
as that can help identify gaps in existing test suites.”h]”(hŒpWhile itâ€™s difficult to provide a single policy, you should ensure that
the changed code is covered by either ”…””}”(hj  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hj  ubhŒÍ or selftests.
In some cases the affected code is run for any guests and functional
tests suffice.  Explain your testing process in the cover letter,
as that can help identify gaps in existing test suites.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h K[hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hjþ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h K_hj&  hžhubj
  )”}”(hX¶  New APIs
It is important to demonstrate your use case.  This can be as simple as
explaining that the feature is already in use on bare metal, or it can be
a proof-of-concept implementation in userspace.  The latter need not be
open source, though that is of course preferrable for easier testing.
Selftests should test corner cases of the APIs, and should also cover
basic host and guest operation if no open source VMM uses the feature.
”h]”(j  )”}”(hŒNew APIs”h]”hŒNew APIs”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h Kghj?  ubj+  )”}”(hhh]”hÕ)”}”(hX¬  It is important to demonstrate your use case.  This can be as simple as
explaining that the feature is already in use on bare metal, or it can be
a proof-of-concept implementation in userspace.  The latter need not be
open source, though that is of course preferrable for easier testing.
Selftests should test corner cases of the APIs, and should also cover
basic host and guest operation if no open source VMM uses the feature.”h]”hX¬  It is important to demonstrate your use case.  This can be as simple as
explaining that the feature is already in use on bare metal, or it can be
a proof-of-concept implementation in userspace.  The latter need not be
open source, though that is of course preferrable for easier testing.
Selftests should test corner cases of the APIs, and should also cover
basic host and guest operation if no open source VMM uses the feature.”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h KbhjQ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hj?  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h Kghj&  hžhubj
  )”}”(hX‹  Bigger features, usually spanning host and guest
These should be supported by Linux guests, with limited exceptions for
Hyper-V features that are testable on Windows guests.  It is strongly
suggested that the feature be usable with an open source host VMM, such
as at least one of QEMU or crosvm, and guest firmware.  Selftests should
test at least API error cases.  Guest operation can be covered by
either selftests of ``kvm-unit-tests`` (this is especially important for
paravirtualized and Windows-only features).  Strong selftest coverage
can also be a replacement for implementation in an open source VMM,
but this is generally not recommended.
”h]”(j  )”}”(hŒ0Bigger features, usually spanning host and guest”h]”hŒ0Bigger features, usually spanning host and guest”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh³h Krhjn  ubj+  )”}”(hhh]”hÕ)”}”(hXY  These should be supported by Linux guests, with limited exceptions for
Hyper-V features that are testable on Windows guests.  It is strongly
suggested that the feature be usable with an open source host VMM, such
as at least one of QEMU or crosvm, and guest firmware.  Selftests should
test at least API error cases.  Guest operation can be covered by
either selftests of ``kvm-unit-tests`` (this is especially important for
paravirtualized and Windows-only features).  Strong selftest coverage
can also be a replacement for implementation in an open source VMM,
but this is generally not recommended.”h]”(hXt  These should be supported by Linux guests, with limited exceptions for
Hyper-V features that are testable on Windows guests.  It is strongly
suggested that the feature be usable with an open source host VMM, such
as at least one of QEMU or crosvm, and guest firmware.  Selftests should
test at least API error cases.  Guest operation can be covered by
either selftests of ”…””}”(hjƒ  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hjƒ  ubhŒÓ (this is especially important for
paravirtualized and Windows-only features).  Strong selftest coverage
can also be a replacement for implementation in an open source VMM,
but this is generally not recommended.”…””}”(hjƒ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Kjhj€  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j*  hjn  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh³h Krhj&  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  hjå  hžhhŸh³h NubhÕ)”}”(hX  Following the above suggestions for testing in selftests and
``kvm-unit-tests`` will make it easier for the maintainers to review
and accept your code.  In fact, even before you contribute your changes
upstream it will make it easier for you to develop for KVM.”h]”(hŒ=Following the above suggestions for testing in selftests and
”…””}”(hjµ  hžhhŸNh Nubj8  )”}”(hŒ``kvm-unit-tests``”h]”hŒkvm-unit-tests”…””}”(hj½  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j7  hjµ  ubhŒ¶ will make it easier for the maintainers to review
and accept your code.  In fact, even before you contribute your changes
upstream it will make it easier for you to develop for KVM.”…””}”(hjµ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Kthjå  hžhubhÕ)”}”(hŒ…Of course, the KVM maintainers reserve the right to require more tests,
though they may also waive the requirement from time to time.”h]”hŒ…Of course, the KVM maintainers reserve the right to require more tests,
though they may also waive the requirement from time to time.”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÔhŸh³h Kyhjå  hžhubeh}”(h]”Œtesting-of-kvm-code”ah ]”h"]”Œtesting of kvm code”ah$]”h&]”uh1h´hh¶hžhhŸh³h K(ubeh}”(h]”Œ review-checklist-for-kvm-patches”ah ]”h"]”Œ review checklist for kvm patches”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jð  jí  jè  jå  uŒ	nametypes”}”(jð  ‰jè  ‰uh}”(jí  h¶jå  jå  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.