direct mode by default in repositories created by assistant

1 files changed, 25 insertions, 0 deletions

diff --git a/doc/assistant/release_notes.mdwn b/doc/assistant/release_notes.mdwn
index 1b39c5086..df478304f 100644
--- a/doc/assistant/release_notes.mdwn
+++ b/doc/assistant/release_notes.mdwn
@@ -1,3 +1,28 @@
+## version 3.20130102
+
+This release makes several significant improvements to the git-annex
+assistant, which is still in beta.
+
+The main improvement is direct mode. This allows you to directly edit files
+in the repository, and the assistant will automatically commit and sync
+your changes. Direct mode is the default for new repositories created
+by the assistant. To convert your existing repository to use direct mode,
+manually run `git annex direct` inside the repository.
+
+The following are known limitations of this release of the git-annex
+assistant:
+
+* If a file in a direct mode repository is modified as it's being transferred,
+  the old version of the file can be lost, and fsck will later complain
+  about a corrupt object.
+* On BSD operating systems (but not on OS X), the assistant uses kqueue to
+  watch files. Kqueue has to open every directory it watches, so too many
+  directories will run it out of the max number of open files (typically
+  1024), and fail. See [[this_bug|bugs/Issue_on_OSX_with_some_system_limits]]
+  for a workaround.
+* Also on systems with kqueue, modifications to existing files in direct
+  mode will not be noticed.
+
 ## version 3.20121211
 
 This release of the git-annex assistant (which is still in beta)