LUDOC-296 protocol: Rearrange presentation to be more top-down

[doc/protocol.git] / struct_obd_uuid.txt

diff --git a/struct_obd_uuid.txt b/struct_obd_uuid.txt
new file mode 100644 (file)
index 0000000..6504863
--- /dev/null
+++ b/struct_obd_uuid.txt
@@ -0,0 +1,18 @@
+Object Based Disk UUID
+^^^^^^^^^^^^^^^^^^^^^^
+[[struct-obd-uuid]]
+
+[source,c]
+----
+#define UUID_MAX        40
+struct obd_uuid {
+        char uuid[UUID_MAX];
+};
+----
+
+The 'uuid' contains an ASCII-formatted string that identifies
+the entity uniquely within the filesystem.  Clients use an RFC-4122
+hexadecimal UUID of the form ''de305d54-75b4-431b-adb2-eb6b9e546014''
+that is randomly generated.  Servers may use a string-based identifier
+of the form ''fsname-TGTindx_UUID''.
+