From 36cf82f0f7f4a0d2b56623d0c8130370658daf9d Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Mon, 22 Jul 2013 13:13:18 +0100 Subject: [PATCH] docs: Document labels and UUIDs in the API overview section. (cherry picked from commit df02c2471f3fe94c691c389c17a5d23d052848dd) --- src/guestfs.pod | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/src/guestfs.pod b/src/guestfs.pod index 65fb00f..0c57f50 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -526,6 +526,34 @@ L after creating each file or directory. For more information about umask, see L. +=head2 LABELS AND UUIDS + +Many filesystems, devices and logical volumes support either labels +(short strings like "BOOT" which might not be unique) and/or UUIDs +(globally unique IDs). + +For filesystems, use L or L to +read the label or UUID. Some filesystems let you call +L or L to change the label or +UUID. + +You can locate a filesystem by its label or UUID using +L or L. + +For LVM2 (which supports only UUIDs), there is a rich set of APIs for +fetching UUIDs, fetching UUIDs of the contained objects, and changing +UUIDs. See: +L, +L, +L, +L, +L, +L, L, +L, L. + +Note when cloning a filesystem, device or whole guest, it is a good +idea to set new randomly generated UUIDs on the copy. + =head2 ENCRYPTED DISKS Libguestfs allows you to access Linux guests which have been -- 1.8.3.1