[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 3/4] rbd: update comment heading
From: |
Sage Weil |
Subject: |
[Qemu-devel] [PATCH 3/4] rbd: update comment heading |
Date: |
Thu, 15 Sep 2011 14:11:10 -0700 |
Properly document the configuration string syntax and semantics. Remove
(out of date) details about the librbd implementation.
Signed-off-by: Sage Weil <address@hidden>
---
block/rbd.c | 28 +++++++++++++---------------
1 files changed, 13 insertions(+), 15 deletions(-)
diff --git a/block/rbd.c b/block/rbd.c
index 43f0e63..202e7ec 100644
--- a/block/rbd.c
+++ b/block/rbd.c
@@ -13,35 +13,33 @@
#include "qemu-common.h"
#include "qemu-error.h"
-
#include "block_int.h"
#include <rbd/librbd.h>
-
-
/*
* When specifying the image filename use:
*
* rbd:poolname/address@hidden:option1=value1[:option2=value2...]]
*
- * poolname must be the name of an existing rados pool
+ * poolname must be the name of an existing rados pool.
*
- * devicename is the basename for all objects used to
- * emulate the raw device.
+ * devicename is the name of the rbd image.
*
- * Each option given is used to configure rados, and may be
- * any Ceph option, or "conf". The "conf" option specifies
- * a Ceph configuration file to read.
+ * Each option given is used to configure rados, and may be any valid
+ * Ceph option, "id", or "conf".
*
- * Metadata information (image size, ...) is stored in an
- * object with the name "devicename.rbd".
+ * The "id" option indicates what user we should authenticate as to
+ * the Ceph cluster. If it is excluded we will use the Ceph default
+ * (normally 'admin').
*
- * The raw device is split into 4MB sized objects by default.
- * The sequencenumber is encoded in a 12 byte long hex-string,
- * and is attached to the devicename, separated by a dot.
- * e.g. "devicename.1234567890ab"
+ * The "conf" option specifies a Ceph configuration file to read. If
+ * it is not specified, we will read from the default Ceph locations
+ * (e.g., /etc/ceph/ceph.conf). To avoid reading _any_ configuration
+ * file, specify conf=/dev/null.
*
+ * Configuration values containing :, @, or = can be escaped with a
+ * leading "\".
*/
#define OBJ_MAX_SIZE (1UL << OBJ_DEFAULT_OBJ_ORDER)
--
1.7.2.5
- [Qemu-devel] [PATCH 0/4] More RBD updates, Sage Weil, 2011/09/15
- [Qemu-devel] [PATCH 3/4] rbd: update comment heading,
Sage Weil <=
- [Qemu-devel] [PATCH 4/4] rbd: call flush, if available, Sage Weil, 2011/09/15
- [Qemu-devel] [PATCH 1/4] rbd: ignore failures when reading from default conf location, Sage Weil, 2011/09/15
- [Qemu-devel] [PATCH 2/4] rbd: allow escaping in config string, Sage Weil, 2011/09/15
- Re: [Qemu-devel] [PATCH 0/4] More RBD updates, Kevin Wolf, 2011/09/19