From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:47907) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R5yCX-0005MM-VL for qemu-devel@nongnu.org; Tue, 20 Sep 2011 07:09:23 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1R5yCS-00007F-Vy for qemu-devel@nongnu.org; Tue, 20 Sep 2011 07:09:21 -0400 Received: from mx1.redhat.com ([209.132.183.28]:33955) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R5yCS-000078-Mb for qemu-devel@nongnu.org; Tue, 20 Sep 2011 07:09:16 -0400 From: Kevin Wolf Date: Tue, 20 Sep 2011 13:11:47 +0200 Message-Id: <1316517112-9908-16-git-send-email-kwolf@redhat.com> In-Reply-To: <1316517112-9908-1-git-send-email-kwolf@redhat.com> References: <1316517112-9908-1-git-send-email-kwolf@redhat.com> Subject: [Qemu-devel] [PATCH 15/20] rbd: update comment heading List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: anthony@codemonkey.ws Cc: kwolf@redhat.com, qemu-devel@nongnu.org From: Sage Weil Properly document the configuration string syntax and semantics. Remove (out of date) details about the librbd implementation. Signed-off-by: Sage Weil Signed-off-by: Kevin Wolf --- block/rbd.c | 28 +++++++++++++--------------- 1 files changed, 13 insertions(+), 15 deletions(-) diff --git a/block/rbd.c b/block/rbd.c index f64b2e0..23d8751 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 - - /* * When specifying the image filename use: * * rbd:poolname/devicename[@snapshotname][: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.6.2