Documentation/virt/kvm/review-checklist.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ================================
   4 Review checklist for kvm patches
   5 ================================
   6
   7 1.  The patch must follow Documentation/process/coding-style.rst and
   8     Documentation/process/submitting-patches.rst.
   9
  10 2.  Patches should be against kvm.git master branch.
  11
  12 3.  If the patch introduces or modifies a new userspace API:
  13     - the API must be documented in Documentation/virt/kvm/api.rst
  14     - the API must be discoverable using KVM_CHECK_EXTENSION
  15
  16 4.  New state must include support for save/restore.
  17
  18 5.  New features must default to off (userspace should explicitly request them).
  19     Performance improvements can and should default to on.
  20
  21 6.  New cpu features should be exposed via KVM_GET_SUPPORTED_CPUID2
  22
  23 7.  Emulator changes should be accompanied by unit tests for qemu-kvm.git
  24     kvm/test directory.
  25
  26 8.  Changes should be vendor neutral when possible.  Changes to common code
  27     are better than duplicating changes to vendor code.
  28
  29 9.  Similarly, prefer changes to arch independent code than to arch dependent
  30     code.
  31
  32 10. User/kernel interfaces and guest/host interfaces must be 64-bit clean
  33     (all variables and sizes naturally aligned on 64-bit; use specific types
  34     only - u64 rather than ulong).
  35
  36 11. New guest visible features must either be documented in a hardware manual
  37     or be accompanied by documentation.
  38
  39 12. Features must be robust against reset and kexec - for example, shared
  40     host/guest memory must be unshared to prevent the host from writing to
  41     guest memory that the guest has not reserved for this purpose.