WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-api

[Xen-API] API Docs

To: xen-api@xxxxxxxxxxxxxxxxxxx
Subject: [Xen-API] API Docs
From: "Richard Hartmann" <richih.mailinglist@xxxxxxxxx>
Date: Thu, 5 Jul 2007 18:36:20 +0200
Delivery-date: Thu, 05 Jul 2007 09:33:58 -0700
Dkim-signature: a=rsa-sha1; c=relaxed/relaxed; d=gmail.com; s=beta; h=domainkey-signature:received:received:message-id:date:from:to:subject:mime-version:content-type; b=F/f3FzZvxixsNTxKUqcYCAzzn+I+iL9dD5lZAa+4zdwKXsUVl+A6w9P2ZDBGZuJYKBekRP/Rudv4baxSaR+f0qHN4meah2bRB0878rqxL7FjadGEy6cvyraIEWD0Ft7IVxU6pZshFm8gL6vL/5zl8Cnlvq5A5NJsMsj6Oxoa2po=
Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=beta; h=received:message-id:date:from:to:subject:mime-version:content-type; b=B0j1rFnORS5l4jw86ZCoJeLBrcuOAMCQZqsrSeNDWkwZAKN/0Y/yNW53MkD8xXEbzDsB4XuYaeVylaRfUQZj0sXSrUwoBqN2bi42FTkz/QrVHZePoEbj+zGtVq6BPAE6T+9jz4/MOEw7KVNHZzIoSF2UhmMv28GuA+ecBrY4z98=
Envelope-to: www-data@xxxxxxxxxxxxxxxxxx
List-help: <mailto:xen-api-request@lists.xensource.com?subject=help>
List-id: Discussion of API issues surrounding Xen <xen-api.lists.xensource.com>
List-post: <mailto:xen-api@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=unsubscribe>
Sender: xen-api-bounces@xxxxxxxxxxxxxxxxxxx
And yes, me again..


Regarding the API doc itself:
I assume it was written in Latex. If that is the case,
a \tableofcontents would greatly improve readability.
Perhaps even with clickable hyperlinks.

Also, it would help to use \\* instead of \\ within API
call blocks. That prevents splitting a single API call
over two pages which happens sometimes.

Finally, a reference for API calls would make a great
appendix enabling people to quickly reference the
calls.


I hope I am not annoying you guys (yet) ;)
Richard
_______________________________________________
xen-api mailing list
xen-api@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-api
<Prev in Thread] Current Thread [Next in Thread>
  • [Xen-API] API Docs, Richard Hartmann <=