aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2015-11-15 16:06:19 +0100
committerJakob Unterwurzacher2015-11-15 16:06:19 +0100
commit2efd25eefe8d3a99e35ccca5a9a8feca759d0f83 (patch)
tree942947614cbb1793c92104a589d35eea73c889f8 /README.md
parent40882c6e49186510a8adc6ae4b41a879c5d3278f (diff)
Update README for v0.4
Also, add short comments to the top of main_test.go and performance_test.go.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index b78ac0a..c41bb47 100644
--- a/README.md
+++ b/README.md
@@ -26,9 +26,11 @@ Only Linux is supported at the moment. Help wanted for a Mac OS X port.
Testing
-------
-gocryptfs comes with is own test suite, run it using `./test.bash`.
+gocryptfs comes with is own test suite that is constantly expanded as features are
+added. Run it using `./test.bash`. It takes about 30 seconds and requires FUSE
+as it mounts several test filesystems.
-In addition, i have ported `xfstests` to FUSE, the result is the
+In addition, I have ported `xfstests` to FUSE, the result is the
[fuse-xfstests](https://github.com/rfjakob/fuse-xfstests) project. gocryptfs
passes the "generic" tests with one exception, results: [XFSTESTS.md](XFSTESTS.md)
@@ -98,14 +100,15 @@ The output should look like this:
Changelog
---------
-v0.4 (in progress)
-* Add `-plaintextnames` command line option
- * Can only be used in conjunction with `-init` and disables filename encryption
- (added on user request)
-* Add `FeatureFlags` config file paramter
+v0.4
+* New command-line options:
+ * `-plaintextnames`: disables filename encryption, added on user request
+ * `-extpass`: calls an external program for prompting for the password
+ * `-config`: allows to specify a custom gocryptfs.conf path
+* Add `FeatureFlags` gocryptfs.conf paramter
* This is a config format change, hence the on-disk format is incremented
* Used for ext4-style filesystem feature flags. This should help avoid future
- format changes.
+ format changes. The first user is `-plaintextnames`.
* On-disk format 2
v0.3