From 910a56a7cb10a1928e6a3edaa5eb15d086460425 Mon Sep 17 00:00:00 2001
From: "Christopher R. Hertel" <crh@samba.org>
Date: Thu, 12 Dec 2013 12:27:10 -0600
Subject: [PATCH] vfs_glusterfs: Comment the top of the file.

Change-Id: I98b512da2e0e56f061247a7c48ce576287b43827
Signed-off-by: Christopher R. Hertel <crh@samba.org>
Reviewed-by: Jose A. Rivera <jarrpa@redhat.com>
Reviewed-by: Ira Cooper <ira@samba.org>
---
 source3/modules/vfs_glusterfs.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/source3/modules/vfs_glusterfs.c b/source3/modules/vfs_glusterfs.c
index 9bcd0cb67b8..f9f8ce1406b 100644
--- a/source3/modules/vfs_glusterfs.c
+++ b/source3/modules/vfs_glusterfs.c
@@ -19,6 +19,24 @@
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file   vfs_glusterfs.c
+ * @author Anand Avati <avati@redhat.com>
+ * @date   May 2013
+ * @brief  Samba VFS module for glusterfs
+ *
+ * @todo
+ *   - AIO support\n
+ *     See, for example \c vfs_aio_linux.c in the \c sourc3/modules directory
+ *   - sendfile/recvfile support
+ *
+ * A Samba VFS module for GlusterFS, based on Gluster's libgfapi.
+ * This is a "bottom" vfs module (not something to be stacked on top of
+ * another module), and translates (most) calls to the closest actions
+ * available in libgfapi.
+ *
+ */
+
 #include "includes.h"
 #include "smbd/smbd.h"
 #include <stdio.h>
@@ -27,14 +45,6 @@
 
 #define DEFAULT_VOLFILE_SERVER "localhost"
 
-/*
-  TODO
-  ----
-  Short term:
-  - AIO support
-  - sendfile/recvfile support
-*/
-
 /* Helpers to provide 'integer' fds */
 
 /* This is global. gfapi's FD operations do not
-- 
2.11.4.GIT