[libvirt] [PATCH] docs: added initial page for c# binding, with links to it
--- docs/bindings.html.in | 2 +- docs/csharp.html.in | 128 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/sitemap.html.in | 4 ++ 3 files changed, 133 insertions(+), 1 deletions(-) create mode 100644 docs/csharp.html.in diff --git a/docs/bindings.html.in b/docs/bindings.html.in index ee63ce3..bdcd231 100644 --- a/docs/bindings.html.in +++ b/docs/bindings.html.in @@ -15,7 +15,7 @@ higher level kind of languages:</p> <li><strong>OCaml</strong>: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li> <li><strong>Ruby</strong>: David Lutterkort provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li> <li><strong>Java</strong>: Daniel Veillard maintains <a href="java.html">Java bindings</a>.</li> - <li><strong>C#</strong>: Jaromír Červenka maintains <a href="http://svn.i-tux.cz/listing.php?repname=SharpLibVirt">C# bindings here</a>.</li> + <li><strong>C#</strong>: Arnaud Champion maintains <a href="csharp.html">C# bindings</a>.</li> <li><strong>PHP</strong>: Radek Hladik is developing <a href="http://phplibvirt.cybersales.cz/">PHP bindings</a>.</li> </ul> <p>For information on using libvirt on <strong>Windows</strong> diff --git a/docs/csharp.html.in b/docs/csharp.html.in new file mode 100644 index 0000000..771b8ca --- /dev/null +++ b/docs/csharp.html.in @@ -0,0 +1,128 @@ +<?xml version="1.0"?> +<html> + <body> + <h1>C# API bindings</h1> + +<!-- 2010-10-19 JC: Commented out until we have C# tarballs to download + <h2>Getting them</h2> + + <p> + The latest versions of the libvirt C# bindings can be downloaded from: + </p> + + <ul> + <li><a href="ftp://libvirt.org/libvirt/csharp/">libvirt.org FTP server</a></li> + <li><a href="http://libvirt.org/sources/csharp/">libvirt.org HTTP server</a></li> + </ul> +--> + + <h2>GIT source repository</h2> + <p> + The C# bindings source code is maintained in a <a + href="http://git-scm.com/">git</a> repository available on + <a href="http://libvirt.org/git/">libvirt.org</a>: + </p> + +<pre> +git clone git://libvirt.org/libvirt-csharp.git +</pre> + + <p> + They can also be browsed online: + </p> + +<pre> +<a href="http://libvirt.org/git/?p=libvirt-csharp.git;a=summary">http://libvirt.org/git/?p=libvirt-csharp.git;a=summary</a> +</pre> + + <p> </p> + + <h2>Authors</h2> + + <p> + The C# bindings are the work of Arnaud Champion + <<a href="mailto:arnaud.champion AT devatom.fr">arnaud.champion AT devatom.fr</a>>, + based upon the previous work of Jaromír Červenka. + </p> + + <p> </p> + + <h2>Function Coverage</h2> + + <p> + Coverage for the C# functions is: + </p> + <table> + <tr><th>Type</th><th>Name</th><th>Binding available?</th><th>Tested?</th><th>Works?</th></tr> + <tr><td>enum</td><td>virCPUCompareResult</td><td>No</td></tr> + <tr><td>struct</td><td>virConnect</td><td>Yes, an IntPtr as the struct is not public</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virConnectAuth</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virConnectCredential</td><td>Yes</td><td>Yes</td><td>Partially, pack problem</td></tr> + <tr><td>enum</td><td>virConnectCredentialType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virConnectFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virDomain</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>struct</td><td>virDomainBlockInfo</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainBlockStatsInfo</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainCoreDumpFlags</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainCreateFlags</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainDeviceModifyFlags</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventDefinedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virDomainEventGraphicsAddress</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventGraphicsAddressType</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventGraphicsPhase</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainEventGraphicsSubject</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainEventGraphicsSubjectIdentity</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventID</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventIOErrorAction</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainEventResumedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventStartedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventStoppedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventSuspendedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventUndefinedDetailType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainEventWatchdogAction</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainInfo</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virDomainInterfaceStatsStruct</td><td>Yes</td><td>No</td><td>Maybe</td></tr> + <tr><td>struct</td><td>virDomainJobInfo</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainJobType</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainMemoryFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainMemoryStatStruct</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainMemoryStatTags</td><td>Yes</td><td>No</td><td>Maybe</td></tr> + <tr><td>enum</td><td>virDomainMigrateFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virDomainSnapshot</td><td>No</td></tr> + <tr><td>enum</td><td>virDomainSnapshotDeleteFlags</td></tr> + <tr><td>enum</td><td>virDomainState</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virDomainXMLFlags</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>enum</td><td>virEventHandleType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virInterface</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>enum</td><td>virInterfaceXMLFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virNWFilter</td><td>No</td></tr> + <tr><td>struct</td><td>virNetwork</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>struct</td><td>virNodeDevice</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>struct</td><td>virNodeInfo</td><td>Yes</td><td>No</td><td>Maybe</td></tr> + <tr><td>struct</td><td>virSchedParameter</td><td>No</td></tr> + <tr><td>enum</td><td>virSchedParameterType</td><td>No</td></tr> + <tr><td>struct</td><td>virSecret</td><td>No</td></tr> + <tr><td>enum</td><td>virSecretUsageType</td><td>No</td></tr> + <tr><td>struct</td><td>virSecurityLabel</td><td>No</td></tr> + <tr><td>struct</td><td>virSecurityModel</td><td>No</td></tr> + <tr><td>struct</td><td>virStoragePool</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>enum</td><td>virStoragePoolBuildFlags</td><td>Yes</td><td>No</td><td>Maybe</td></tr> + <tr><td>enum</td><td>virStoragePoolDeleteFlags</td><td>Yes</td><td>No</td><td>Maybe</td></tr> + <tr><td>struct</td><td>virStoragePoolInfo</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virStoragePool</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>enum</td><td>virStoragePoolState</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virStorageVol</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>enum</td><td>virStorageVolDeleteFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virStorageVolInfo</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virStorageVol</td><td>Yes, an IntPtr as the struct is not public</td></tr> + <tr><td>enum</td><td>virStorageVolType</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> + <tr><td>struct</td><td>virStream</td><td>No</td></tr> + <tr><td>enum</td><td>virStreamEventType</td><td>No</td></tr> + <tr><td>enum</td><td>virStreamFlags</td><td>No</td></tr> + <tr><td>struct</td><td>virVcpuInfo</td><td>No</td></tr> + <tr><td>enum</td><td>virVcpuState</td><td>No</td></tr> + </table> + + </body> +</html> diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index 481507e..5f46b59 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -242,6 +242,10 @@ <a href="java.html">Java</a> <span>overview of the Java API bindings</span> </li> + <li> + <a href="csharp.html">C#</a> + <span>overview of the C# API bindings</span> + </li> </ul> </li> <li> -- 1.7.2.3
On 10/19/2010 06:03 AM, Justin Clift wrote:
--- docs/bindings.html.in | 2 +- docs/csharp.html.in | 128 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/sitemap.html.in | 4 ++ 3 files changed, 133 insertions(+), 1 deletions(-) create mode 100644 docs/csharp.html.in
Please ignore this patch. I'll submit a v2 tomorrow, after updating it to include more info. :)
participants (1)
-
Justin Clift