Documentation/virtual/kvm/review-checklist.txt

liuming794

Chinese translated version of Documentation/virtual/kvm/review-checklist.txt


If you have any comment or update to the content, please contact the
original document maintainer directly.  However, if you have a problem
communicating in English you can also ask the Chinese maintainer for
help.  Contact the Chinese maintainer if this translation is outdated
or if there is a problem with the translation.




Chinese maintainer: 金鑫 575068677@qq.com
---------------------------------------------------------------------


Documentation/virtual/kvm/review-checklist.txt 的中文翻译




如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文
交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻
译存在问题，请联系中文版维护者。




中文版维护者： 金鑫 575068677@qq.com
中文版翻译者： 金鑫 575068677@qq.com
中文版校译者： 金鑫 575068677@qq.com




以下为正文
---------------------------------------------------------------------









Review checklist for kvm patches
KVM（基于内核的虚拟机）补丁审查
================================


1.  The patch must follow Documentation/CodingStyle and
    Documentation/SubmittingPatches.
补丁必须遵守Documentation/CodingStyle 和 Documentation/SubmittingPatches。

2.  Patches should be against kvm.git master branch.
补丁应该违反kvm.git主分支。

3.  If the patch introduces or modifies a new userspace API:
    - the API must be documented in Documentation/virtual/kvm/api.txt
    - the API must be discoverable using KVM_CHECK_EXTENSION
如果补丁介绍活修改一个新的userspace API函数:
-API  函数必须在Documentation/virtual/kvm/api.txt文件中备份
-API　函数必须可以被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
新的CPU特性应该可以通过KVM_GET_SUPPORTED_CPUID2揭露。

7.  Emulator changes should be accompanied by unit tests for qemu-kvm.git
    kvm/test directory.
仿真器的改变应该通过qemu-kvm.git  kvm/test目录下的单元测试。

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).
User/kernel 接口和 guest/host 接口必须是64位的（所有的变量大小都是按照64位自动对齐的
使用特性类型 u64而不是 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.
特性必须是强健的禁得住清零和执行 - 例如，共享 host/guest内存必须防止管理员
写数据进用户的内存空间，数据没有按照管理员的意愿保存。