add notes on changes in my branch

git-svn-id: http://pyfilesystem.googlecode.com/svn/branches/rfk-ideas@155 67cdc799-7952-0410-af00-57a81ceafa0f

1 files changed, 35 insertions, 0 deletions

diff --git a/NOTES.txt b/NOTES.txt
new file mode 100644
index 0000000..7e1df55
--- /dev/null
+++ b/NOTES.txt
@@ -0,0 +1,35 @@
+
+Rename 'helpers' module to 'path' since it's basically an imitation of os.path.
+Minify the contained functions:
+   - make normpath() do more e.g. collapse backrefs
+   - remove resolvepath() as it just confuses the issue
+   - resourcename() -> basename() in line with os.path notation
+   - remove isabsolutepath(), it wasn't used
+
+Put error class definitions in separate submodule 'errors'
+   - deeper exception heirachy and less redundancy
+     (e.g. no more `raise UnsupportedError("UNSUPPORTED")`)
+
+Remove the notion of hidden files from the base FS class.
+   - it's not the filesystem's business to decide what files I want to see
+   - has lead to several bugs with copying/moving directories
+   - moved the logic into a separate wrapper class, currently
+     in fs.wrapfs.HideDotFiles
+
+Remove xattr support from base FS class, making it a separate interface.
+   - now defined in fs.xattrs module
+   - SimulateXAttr wrapper class contains the same logic
+   - removexattr() -> delxattr() in line with python's get/set/del tradition
+
+Operational changes to the base methods:
+   - don't require makedir() to support the "mode" argument, since this only
+     makes sense for OS-level files.
+   - when copy() is given an existing directory as destination, raise an error
+     rather than copying into the directory (explicit is better than implicit)
+
+Split up the test definitions a little:
+   - use a separate FSTestCases mixin rather than subclassing TestOSFS
+   - path helpers testcases in their own module
+   - zipfs in its own module since it's different to all the others
+   - s3fs in its own module since it's very slow
+