Fix 'make doc'
[virt-df.git] / lib / diskimage_lvm2_metadata.mli
1 (** diskimage plugin for Linux LVM2 *)
2 (* 'df' command for virtual domains.
3    (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc.
4    http://libvirt.org/
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2 of the License, or (at your option) any later version,
10    with the OCaml linking exception described in ../COPYING.LIB.
11
12    This library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16
17    You should have received a copy of the GNU Lesser General Public
18    License along with this library; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
20  *)
21
22 (* Part of the parser for LVM2 metadata. *)
23
24 type metadata = metastmt list
25
26 and metastmt = string * metavalue
27
28 and metavalue =
29   | Metadata of metadata                (* name { ... } *)
30   | String of string                    (* name = "..." *)
31   | Int of Int63.t
32   | Float of float
33   | List of metavalue list              (* name = [...] *)
34
35 val output_metadata : out_channel -> metadata -> unit
36 (** This function prints out the metadata on the selected channel.
37
38     The output format isn't particularly close to the input
39     format.  This is just for debugging purposes.
40 *)