summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaghavendra G <rgowdapp@redhat.com>2014-05-28 15:12:42 +0530
committerNiels de Vos <ndevos@redhat.com>2014-05-31 01:37:47 -0700
commitfda408e0ea652d643ad0005f1863cd560edd942f (patch)
tree2e75d2bc6dc1e7f8d52710fbf1b14c129cf5beea
parentfed8145a9e3bafa6cc326bf7487940791b2efb30 (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/7904 Reviewed-by: Humble Devassy Chirammal <humble.devassy@gmail.com> Reviewed-by: Niels de Vos <ndevos@redhat.com> Tested-by: Niels de Vos <ndevos@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