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/
Home Products Support Community News


[Xen-API] Prettier output from latex_backend.ml

To: Xen-API List <xen-api@xxxxxxxxxxxxxxxxxxx>
Subject: [Xen-API] Prettier output from latex_backend.ml
From: Magnus Therning <magnus.therning@xxxxxxxxxx>
Date: Wed, 24 Nov 2010 15:36:45 +0000
Delivery-date: Wed, 24 Nov 2010 07:37:07 -0800
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
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/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=unsubscribe>
Sender: xen-api-bounces@xxxxxxxxxxxxxxxxxxx
User-agent: Mutt/1.5.21 (2010-09-15)
I've attached a patch that modifies how the latex version of the api docs is
generated.  I've uploaded the api document as it's generated with this patch
applied to [1].  A short description of the changes:

- use a latex style for the class descriptions
- use a proper pretty printer for the output

diffstat says:

 b/ocaml/idl/xenclass.sty       |  127 ++++++++++++++++++++++++++
 ocaml/idl/OMakefile            |    4 
 ocaml/idl/latex_backend.ml     |  193 +++++++++++++++++++----------------------
 ocaml/idl/xenenterpriseapi.tex |    1 
 4 files changed, 222 insertions(+), 103 deletions(-)

The changes make use of prettier[2].

There are further improvements possible, but first I'd like to get some
feedback on whether this is considered an improvement or not. :-)


[1] http://dl.dropbox.com/u/187401/xenenterpriseapi-prettier.pdf
[2] https://github.com/magthe/prettier

Magnus Therning                            magnus.therning@xxxxxxxxxx
XenServer Security Lead

There does not now, nor will there ever, exist a programming language
in which it is the least bit hard to write bad programs.
     -- Flon's Axiom

Most software today is very much like an Egyptian pyramid with
millions of bricks piled on top of each other, with no structural
integrity, but just done by brute force and thousands of slaves.
     -- Alan Kay

Attachment: prettier.patch
Description: Text document

xen-api mailing list
<Prev in Thread] Current Thread [Next in Thread>
  • [Xen-API] Prettier output from latex_backend.ml, Magnus Therning <=