[libvirt] [PATCH] Add some docs about the RPC protocol and APIs

[Daniel P. Berrange]

On Thu, Aug 11, 2011 at 12:42:06PM -0600, Eric Blake wrote:
> On 08/11/2011 09:12 AM, Daniel P. Berrange wrote:
> >From: "Daniel P. Berrange"<berrange at redhat.com>
> >
> >* remote.html.in: Remove obsolete notes about internals of the
> >   RPC protocol
> >* internals/rpc.html.in: Extensive docs on RPC protocol/API
> >* sitemap.html.in: Add new page
> >---
> >  docs/internals/rpc.html.in |  876 ++++++++++++++++++++++++++++++++++++++++++++
> >  docs/remote.html.in        |   45 ---
> >  docs/sitemap.html.in       |    4 +
> >  3 files changed, 880 insertions(+), 45 deletions(-)
> >  create mode 100644 docs/internals/rpc.html.in
> 
> ACK, and very nice.  Some nits below to fix first...
> 
> >+<p>
> >+      libvirt includes a basic protocol and code to implement
> >+      an extensible, secure client/server RPC service. This was
> >+      originally designed for communication between the libvirt
> >+      client library and the libvirtd daemon. It is also also
> >+      used for communication to the virtlockd daemon and (soon)
> > +      for the libvirt_lxc controller process. This document
> 
> Do we want to mention "(soon)"?  I find that docs tend to quickly
> get outdated (a new feature gets added, and we forget to modify this
> file, and then the reference to soon sounds funny).  Conversely, we
> don't have libvirt_lxc controller yet, so mentioning it without some
> disclaimer also seems odd.  I don't have any better suggestion,
> other than to remember to delete "(soon)" once we do add libvirt_lxc
> controller.

I changed it thus:

  -      client library and the libvirtd daemon. It is also also
  -      used for communication to the virtlockd daemon and (soon)
  -      for the libvirt_lxc controller process. This document
  -      provides an overview of the protocol and structure / operation
  -      of the internal RPC library APIs.
  +      client library and the libvirtd daemon, but the code is
  +      now isolated to allow reuse in other areas of libvirt code.
  +      This document provides an overview of the protocol and
  +      structure / operation of the internal RPC library APIs.


Pushed with all changes people mentioned here.

Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|