aboutsummaryrefslogtreecommitdiff
path: root/docs/directories.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/directories.rst')
-rw-r--r--docs/directories.rst18
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/directories.rst b/docs/directories.rst
index 985d9ba38..92f3646ac 100644
--- a/docs/directories.rst
+++ b/docs/directories.rst
@@ -1,19 +1,21 @@
Directories and files
===========================
-When talking about file systems, many people would assume directories, list files under a directory, etc. These are expected if we want to hook up Seaweed File System with linux by FUSE, or with Hadoop, etc.
+When talking about file systems, many people would assume directories,
+list files under a directory, etc. These are expected if we want to hook up
+Seaweed File System with linux by FUSE, or with Hadoop, etc.
Sample usage
#####################
-Two ways to start a weed filer
+Two ways to start a weed filer in standalone mode:
.. code-block:: bash
-
+
# assuming you already started weed master and weed volume
weed filer
- # Or assuming you have nothing started yet,
- # this command starts master server, volume server, and filer in one shot.
+ # Or assuming you have nothing started yet,
+ # this command starts master server, volume server, and filer in one shot.
# It's strictly the same as starting them separately.
weed server -filer=true
@@ -80,10 +82,10 @@ This assumed differences between directories and files lead to the design that t
* efficient to move/rename/list_directories
* Store files in a sorted string table in <dir_id/filename, file_id> format
-
+
* efficient to list_files, just simple iterator
* efficient to locate files, binary search
-
+
Complexity
###################
@@ -131,4 +133,4 @@ Helps Wanted
This is a big step towards more interesting Seaweed-FS usage and integration with existing systems.
-If you can help to refactor and implement other directory meta data, or file meta data storage, please do so. \ No newline at end of file
+If you can help to refactor and implement other directory meta data, or file meta data storage, please do so.