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

On 08/11/2011 09:12 AM, Daniel P. Berrange wrote: >From: "Daniel P. Berrange&quot;&lt;berrange(a)redhat.com&gt; > >* 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.