[libvirt] [PATCH 0/8] Web page updates/changes

John Ferlan jferlan at redhat.com
Tue Feb 19 02:14:03 UTC 2013


I was [t]asked to make updates to the api webpage including an example
of a code path from application into the driver. As I started on the task
I found that the api webpage first needed a couple of updates just to fill
in what seems to have been missing information.  As I went through the
various pages I realized that the 'better' location for the example code
path seemed to be the internals page and thus I added it there.  My simple
example (hah!) was the virConnectOpen code path - I figured for a intro-
duction to the internals web page - it'd be a good place to start.

While I was doing this I used the hellolibvirt example a bit and based on
information found on the 'api' page I added some more calls into the example
to print network and disk information as well as more domain data.

Finally while going through the pages I found a couple of places where
drv pages weren't referenced although they were available, so I updated
those (phyp and parallels).

Hopefully I've figured things out correctly, but I'm sure if I have something
a bit wrong someone will correct me. Making the figure was quite frustrating
as xfig is a bit less forgiving than say office writer.

John Ferlan (8):
  hellolibvirt: Update hellolibvirt example
  api: Reword objects exposed section
  api: Reword and clean lists for object description
  api: Complete list of function and naming conventions
  api: Add text and references for drivers section
  api: Add text and references for daemon
  Add references for phyp and parallels
  internals: Update to include RPC and Lock links and add new data

 docs/api.html.in                     | 261 +++++++++++++++++++++++++----------
 docs/drivers.html.in                 |   1 +
 docs/index.html.in                   |   6 +
 docs/internals.html.in               | 102 +++++++++++++-
 docs/libvirt-virConnect-example.fig  |  58 ++++++++
 docs/libvirt-virConnect-example.png  | Bin 0 -> 10464 bytes
 docs/sitemap.html.in                 |   8 ++
 examples/hellolibvirt/hellolibvirt.c | 201 +++++++++++++++++++++++----
 8 files changed, 530 insertions(+), 107 deletions(-)
 create mode 100644 docs/libvirt-virConnect-example.fig
 create mode 100644 docs/libvirt-virConnect-example.png

-- 
1.7.11.7




More information about the libvir-list mailing list