summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaghavendra G <rgowdapp@redhat.com>2014-05-28 15:12:42 +0530
committerVijay Bellur <vbellur@redhat.com>2014-05-29 23:08:48 -0700
commit57df032636f613469cf0ef0a3ecffdcd2cd51249 (patch)
treedef458abe6fbafb61aa275ae6dc27e2163fe4952
parenta181282d1465c98c9b07bc7ea37e7096a7799a11 (diff)
doc: add readdir-ahead documentation
Change-Id: Ib6fc3c9b59b498bfe3fb3dfc23dca874bdc0d21d BUG: 1086755 Signed-off-by: Raghavendra G <rgowdapp@redhat.com> Reviewed-on: http://review.gluster.org/7903 Reviewed-by: Brian Foster <bfoster@redhat.com> Reviewed-by: Humble Devassy Chirammal <humble.devassy@gmail.com> Reviewed-by: Vijay Bellur <vbellur@redhat.com> Tested-by: Vijay Bellur <vbellur@redhat.com>
-rw-r--r--doc/features/readdir-ahead.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/features/readdir-ahead.md b/doc/features/readdir-ahead.md
new file mode 100644
index 00000000000..5302a021202
--- /dev/null
+++ b/doc/features/readdir-ahead.md
@@ -0,0 +1,14 @@
+## Readdir-ahead ##
+
+### Summary ###
+Provide read-ahead support for directories to improve sequential directory read performance.
+
+### Owners ###
+Brian Foster
+
+### Detailed Description ###
+The read-ahead feature for directories is analogous to read-ahead for files. The objective is to detect sequential directory read operations and establish a pipeline for directory content. When a readdir request is received and fulfilled, preemptively issue subsequent readdir requests to the server in anticipation of those requests from the user. If sequential readdir requests are received, the directory content is already immediately available in the client. If subsequent requests are not sequential or not received, said data is simply dropped and the optimization is bypassed.
+
+readdir-ahead is currently disabled by default. It can be enabled with the following command:
+
+ gluster volume set <volname> readdir-ahead on