This document walks you through the process of implementing a new API in libvirt. It uses as an example the addition of an API for - separating maximum from current vcpu usage of a domain. + separating maximum from current vcpu usage of a domain, over + the course of a fifteen-patch series. Remember that new API consists of any new public functions, as well as the addition of flags or extensions of XML used by existing functions. The example in this document adds both new @@ -134,8 +135,8 @@ rework it as you go through the process of implementing it.
-See 0001-Step-1-of-15-add-to-xml.patch - and 0002-Step-2-of-15-add-new-public-API.patch +
See 0001-add-to-xml.patch + and 0002-add-new-public-API.patch for example code.
NULL stub for the new function.
- See 0003-Step-3-of-15-define-internal-driver-API.patch
+See 0003-define-internal-driver-API.patch
src/libvirt.c
See 0004-Step-4-of-15-implement-the-public-APIs.patch
+See 0004-implement-the-public-APIs.patch
See 0005-Step-5-of-15-implement-the-remote-protocol.patch
+See 0005-implement-the-remote-protocol.patch
See 0005-Step-5-of-15-implement-the-remote-protocol.patch
+See 0005-implement-the-remote-protocol.patch
See 0006-Step-6-of-15-make-old-API-trivially-wrap-to-new-API.patch
+See 0006-make-old-API-trivially-wrap-to-new-API.patch
See 0007-Step-7-of-15-add-virsh-support.patch
+See 0007-add-virsh-support.patch
See 0008-Step-8-of-15-support-new-xml.patch
+See 0008-support-new-xml.patch
See 0009-Step-9-of-15-support-all-flags-in-test-driver.patch
+See 0009-support-all-flags-in-test-driver.patch
The qemu changes were easier to split into two phases, one for @@ -400,8 +401,8 @@ flags of the new API:
-See 0010-Step-10-of-15-improve-vcpu-support-in-qemu-command-line.patch - and 0011-Step-11-of-15-complete-vcpu-support-in-qemu-driver.patch
+See 0010-improve-vcpu-support-in-qemu-command-line.patch + and 0011-complete-vcpu-support-in-qemu-driver.patch
Finally, the example breaks the xen driver changes across four @@ -411,10 +412,10 @@ rendered dead by the new API.
-See 0012-Step-12-of-15-improve-vcpu-support-in-xen-command-line.patch, - 0013-Step-13-of-15-improve-support-for-getting-xen-vcpu-counts.patch, - 0014-Step-14-of-15-improve-support-for-setting-xen-vcpu-counts.patch, - and 0015-Step-15-of-15-remove-dead-xen-code.patch
+See 0012-improve-vcpu-support-in-xen-command-line.patch, + 0013-improve-getting-xen-vcpu-counts.patch, + 0014-improve-setting-xen-vcpu-counts.patch, + and 0015-remove-dead-xen-code.patch
The exact details of the example code are probably uninteresting diff --git a/docs/api_extension/0001-Step-1-of-15-add-to-xml.patch b/docs/api_extension/0001-add-to-xml.patch similarity index 100% rename from docs/api_extension/0001-Step-1-of-15-add-to-xml.patch rename to docs/api_extension/0001-add-to-xml.patch diff --git a/docs/api_extension/0002-Step-2-of-15-add-new-public-API.patch b/docs/api_extension/0002-add-new-public-API.patch similarity index 100% rename from docs/api_extension/0002-Step-2-of-15-add-new-public-API.patch rename to docs/api_extension/0002-add-new-public-API.patch diff --git a/docs/api_extension/0003-Step-3-of-15-define-internal-driver-API.patch b/docs/api_extension/0003-define-internal-driver-API.patch similarity index 100% rename from docs/api_extension/0003-Step-3-of-15-define-internal-driver-API.patch rename to docs/api_extension/0003-define-internal-driver-API.patch diff --git a/docs/api_extension/0004-Step-4-of-15-implement-the-public-APIs.patch b/docs/api_extension/0004-implement-the-public-APIs.patch similarity index 100% rename from docs/api_extension/0004-Step-4-of-15-implement-the-public-APIs.patch rename to docs/api_extension/0004-implement-the-public-APIs.patch diff --git a/docs/api_extension/0005-Step-5-of-15-implement-the-remote-protocol.patch b/docs/api_extension/0005-implement-the-remote-protocol.patch similarity index 100% rename from docs/api_extension/0005-Step-5-of-15-implement-the-remote-protocol.patch rename to docs/api_extension/0005-implement-the-remote-protocol.patch diff --git a/docs/api_extension/0006-Step-6-of-15-make-old-API-trivially-wrap-to-new-API.patch b/docs/api_extension/0006-make-old-API-trivially-wrap-to-new-API.patch similarity index 100% rename from docs/api_extension/0006-Step-6-of-15-make-old-API-trivially-wrap-to-new-API.patch rename to docs/api_extension/0006-make-old-API-trivially-wrap-to-new-API.patch diff --git a/docs/api_extension/0007-Step-7-of-15-add-virsh-support.patch b/docs/api_extension/0007-add-virsh-support.patch similarity index 100% rename from docs/api_extension/0007-Step-7-of-15-add-virsh-support.patch rename to docs/api_extension/0007-add-virsh-support.patch diff --git a/docs/api_extension/0008-Step-8-of-15-support-new-xml.patch b/docs/api_extension/0008-support-new-xml.patch similarity index 100% rename from docs/api_extension/0008-Step-8-of-15-support-new-xml.patch rename to docs/api_extension/0008-support-new-xml.patch diff --git a/docs/api_extension/0009-Step-9-of-15-support-all-flags-in-test-driver.patch b/docs/api_extension/0009-support-all-flags-in-test-driver.patch similarity index 100% rename from docs/api_extension/0009-Step-9-of-15-support-all-flags-in-test-driver.patch rename to docs/api_extension/0009-support-all-flags-in-test-driver.patch diff --git a/docs/api_extension/0010-Step-10-of-15-improve-vcpu-support-in-qemu-command-line.patch b/docs/api_extension/0010-improve-vcpu-support-in-qemu-command-line.patch similarity index 100% rename from docs/api_extension/0010-Step-10-of-15-improve-vcpu-support-in-qemu-command-line.patch rename to docs/api_extension/0010-improve-vcpu-support-in-qemu-command-line.patch diff --git a/docs/api_extension/0011-Step-11-of-15-complete-vcpu-support-in-qemu-driver.patch b/docs/api_extension/0011-complete-vcpu-support-in-qemu-driver.patch similarity index 100% rename from docs/api_extension/0011-Step-11-of-15-complete-vcpu-support-in-qemu-driver.patch rename to docs/api_extension/0011-complete-vcpu-support-in-qemu-driver.patch diff --git a/docs/api_extension/0012-Step-12-of-15-improve-vcpu-support-in-xen-command-line.patch b/docs/api_extension/0012-improve-vcpu-support-in-xen-command-line.patch similarity index 100% rename from docs/api_extension/0012-Step-12-of-15-improve-vcpu-support-in-xen-command-line.patch rename to docs/api_extension/0012-improve-vcpu-support-in-xen-command-line.patch diff --git a/docs/api_extension/0013-Step-13-of-15-improve-support-for-getting-xen-vcpu-counts.patch b/docs/api_extension/0013-improve-getting-xen-vcpu-counts.patch similarity index 100% rename from docs/api_extension/0013-Step-13-of-15-improve-support-for-getting-xen-vcpu-counts.patch rename to docs/api_extension/0013-improve-getting-xen-vcpu-counts.patch diff --git a/docs/api_extension/0014-Step-14-of-15-improve-support-for-setting-xen-vcpu-counts.patch b/docs/api_extension/0014-improve-setting-xen-vcpu-counts.patch similarity index 100% rename from docs/api_extension/0014-Step-14-of-15-improve-support-for-setting-xen-vcpu-counts.patch rename to docs/api_extension/0014-improve-setting-xen-vcpu-counts.patch diff --git a/docs/api_extension/0015-Step-15-of-15-remove-dead-xen-code.patch b/docs/api_extension/0015-remove-dead-xen-code.patch similarity index 100% rename from docs/api_extension/0015-Step-15-of-15-remove-dead-xen-code.patch rename to docs/api_extension/0015-remove-dead-xen-code.patch