summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorAvi Kivity <avi@redhat.com>2010-06-24 14:10:09 +0300
committerAvi Kivity <avi@redhat.com>2010-08-01 10:47:20 +0300
commitcf3e3d3e19868ca01da163200bbfc687523df0fc (patch)
treed527fd15aa753f592398e8208d2713b9f8ffa6dd /Documentation
parent3e0075094734de122e4cb09f930fa853a3c59f09 (diff)
downloadlinux-3.10-cf3e3d3e19868ca01da163200bbfc687523df0fc.tar.gz
linux-3.10-cf3e3d3e19868ca01da163200bbfc687523df0fc.tar.bz2
linux-3.10-cf3e3d3e19868ca01da163200bbfc687523df0fc.zip
KVM: Document KVM specific review items
Signed-off-by: Avi Kivity <avi@redhat.com> Signed-off-by: Marcelo Tosatti <mtosatti@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/kvm/review-checklist.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/kvm/review-checklist.txt b/Documentation/kvm/review-checklist.txt
new file mode 100644
index 00000000000..730475ae1b8
--- /dev/null
+++ b/Documentation/kvm/review-checklist.txt
@@ -0,0 +1,38 @@
+Review checklist for kvm patches
+================================
+
+1. The patch must follow Documentation/CodingStyle and
+ Documentation/SubmittingPatches.
+
+2. Patches should be against kvm.git master branch.
+
+3. If the patch introduces or modifies a new userspace API:
+ - the API must be documented in Documentation/kvm/api.txt
+ - the API must be discoverable using KVM_CHECK_EXTENSION
+
+4. New state must include support for save/restore.
+
+5. New features must default to off (userspace should explicitly request them).
+ Performance improvements can and should default to on.
+
+6. New cpu features should be exposed via KVM_GET_SUPPORTED_CPUID2
+
+7. Emulator changes should be accompanied by unit tests for qemu-kvm.git
+ kvm/test directory.
+
+8. Changes should be vendor neutral when possible. Changes to common code
+ are better than duplicating changes to vendor code.
+
+9. Similarly, prefer changes to arch independent code than to arch dependent
+ code.
+
+10. 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).
+
+11. New guest visible features must either be documented in a hardware manual
+ or be accompanied by documentation.
+
+12. Features must be robust against reset and kexec - for example, shared
+ host/guest memory must be unshared to prevent the host from writing to
+ guest memory that the guest has not reserved for this purpose.