[libvirt] [PATCH v2] docs: api_extension: Update paths in the examples

Peter Krempa posted 1 patch 5 years, 7 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/351b2eb11c8e3e74522134cf3fdc8a021662d242.1535460096.git.pkrempa@redhat.com
Test syntax-check passed
docs/api_extension.html.in | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
[libvirt] [PATCH v2] docs: api_extension: Update paths in the examples
Posted by Peter Krempa 5 years, 7 months ago
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
v2:
 - switched from '$SECTION' to '$MODULE' as a hint for the split files
 - changed 'domain.rng' to 'domaincommon.rng' which contains the defs
 - added the '$MODULE' to virsh path

Note some still may be wrong as I did not chec all paths rigorously.

 docs/api_extension.html.in | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/api_extension.html.in b/docs/api_extension.html.in
index 33d82e6ac6..d7fbbd6e90 100644
--- a/docs/api_extension.html.in
+++ b/docs/api_extension.html.in
@@ -96,7 +96,7 @@
       schema and document the new elements or attributes:</p>

     <p><code>
-        docs/schemas/domain.rng<br/>
+        docs/schemas/domaincommon.rng<br/>
         docs/formatdomain.html.in
     </code></p>

@@ -106,7 +106,7 @@
       libvirt library and call the new function:</p>

     <p><code>
-        include/libvirt/libvirt.h.in
+        include/libvirt/libvirt-$MODULE.h.in
         src/libvirt_public.syms
     </code></p>

@@ -137,7 +137,7 @@

     <p>The driver structs are defined in:</p>

-    <p><code>src/driver.h</code></p>
+    <p><code>src/driver-$MODULE.h</code></p>

     <p>
       To define the internal API, first typedef the driver function
@@ -177,7 +177,7 @@

     <p>The public API calls are implemented in:</p>

-    <p><code>src/libvirt.c</code></p>
+    <p><code>src/libvirt-$MODULE.c</code></p>

     <h2><a name='remoteproto'>Implementing the remote protocol</a></h2>

@@ -219,9 +219,9 @@
     </p>

     <p><code>
-        daemon/remote_dispatch_args.h
-        daemon/remote_dispatch_prototypes.h
-        daemon/remote_dispatch_table.h
+        src/remote/remote_daemon_dispatch_stubs.h
+        src/remote/remote_daemon_dispatch.h
+        src/remote/remote_daemon_dispatch.c
         src/remote/remote_protocol.c
         src/remote/remote_protocol.h
     </code></p>
@@ -233,7 +233,7 @@
       method calls go in:
     </p>

-    <p><code>src/remote/remote_internal.c</code></p>
+    <p><code>src/remote/remote_driver.c</code></p>

     <p>Each remote method invocation does the following:</p>

@@ -256,7 +256,7 @@
       The server side dispatchers are implemented in:
     </p>

-    <p><code>daemon/remote.c</code></p>
+    <p><code>src/remote/daemon_dispatch.c</code></p>

     <p>Again, this step uses the .h files generated by make rpcgen.</p>

@@ -309,7 +309,7 @@
     </p>

     <p><code>
-        tools/virsh.c<br/>
+        tools/virsh-$MODULE.c<br/>
         tools/virsh.pod
     </code></p>

-- 
2.16.2

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH v2] docs: api_extension: Update paths in the examples
Posted by Ján Tomko 5 years, 7 months ago
On Tue, Aug 28, 2018 at 02:43:29PM +0200, Peter Krempa wrote:
>Signed-off-by: Peter Krempa <pkrempa@redhat.com>
>---
>v2:
> - switched from '$SECTION' to '$MODULE' as a hint for the split files
> - changed 'domain.rng' to 'domaincommon.rng' which contains the defs
> - added the '$MODULE' to virsh path
>
>Note some still may be wrong as I did not chec all paths rigorously.
>
> docs/api_extension.html.in | 20 ++++++++++----------
> 1 file changed, 10 insertions(+), 10 deletions(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list