Skip to content

Commit

Permalink
cleanup formatting on README
Browse files Browse the repository at this point in the history
  • Loading branch information
David Snyder committed Jan 21, 2012
1 parent cb3c1ca commit 136c08b
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,16 @@ h1. Swineherd-fs
* @ls_r@
* @mkdir_p@

Note: Since S3 is just a key-value store, it is difficult to preserve the notion of a directory. Therefore the @mkdir_p@ function has no purpose, as there cannot be empty directories. @mkdir_p@ currently only ensures that the bucket exists. This implies that the @directory?@ test only succeeds if the directory is non-empty, which clashes with the notion on the UNIX filesystem.

Additionally, the S3 and HDFS abstractions implement functions for moving files to and from the local filesystem:
p. Note: Since S3 is just a key-value store, it is difficult to preserve the notion of a directory. Therefore the @mkdir_p@ function has no purpose, as there cannot be empty directories. @mkdir_p@ currently only ensures that the bucket exists. This implies that the @directory?@ test only succeeds if the directory is non-empty, which clashes with the notion on the UNIX filesystem.
p. Additionally, the S3 and HDFS abstractions implement functions for moving files to and from the local filesystem:

* @copy_to_local@
* @copy_from_local@

Note: For these methods the destination and source path respectively are assumed to be local, so they do not have to be prefaced by a filescheme.
p. Note: For these methods the destination and source path respectively are assumed to be local, so they do not have to be prefaced by a filescheme.

The @Swineherd::FileSystem@ module implements a generic filesystem abstraction using schemed filepaths (hdfs://,s3://,file://).

p. The @Swineherd::FileSystem@ module implements a generic filesystem abstraction using schemed filepaths (hdfs://,s3://,file://).
Currently only the following methods are supported for @Swineherd::FileSystem@:

* @cp@
Expand All @@ -44,7 +43,7 @@ h1. Swineherd-fs
fs.cp('hdfs://foo/bar/baz.txt','foo/bar/baz.txt') unless fs.exists?('foo/bar/baz.txt')
</code></pre>

Note: A path without a scheme is treated as a path on the local filesystem, or use the explicit file:// scheme for clarity. The following are equivalent:
p. Note: A path without a scheme is treated as a path on the local filesystem, or use the explicit file:// scheme for clarity. The following are equivalent:

<pre><code>fs.exists?('foo/bar/baz.txt')
fs.exists?('file://foo/bar/baz.txt')
Expand All @@ -65,7 +64,7 @@ h4. Config

<pre><code>S3 = Swineherd::S3FileSystem.new(:access_key => "my_access_key",:secret_key => "my_secret_key")</code></pre>

h4. JRuby for HadoopFileSystem
h4. JRuby for HadoopFileSystem

* @jruby -S gem install swineherd-fs@

Expand Down

0 comments on commit 136c08b

Please sign in to comment.