summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Compatibility.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/Compatibility.md b/Compatibility.md
index a2fb4de..bc9636d 100644
--- a/Compatibility.md
+++ b/Compatibility.md
@@ -1,6 +1,8 @@
+### On-Disk-Format Compatability
+
gocryptfs uses ext4-style *feature flags* to add new functionality or better security to the on-disk-format. These are stored in `gocryptfs.conf` as `FeatureFlags`. When a new feature flag is added, gocryptfs will continue to support mounting older filesystems that do not have this flag set.
-However, from time to time major gocryptfs revisions will drop support for very old filesystems. This keeps the gocryptfs code base clean and maintainable.
+However, from time to time major gocryptfs revisions will drop support for very old filesystems. This keeps the gocryptfs code base clean and maintainable. Users are encouraged to upgrade their filesystems (see below for how) as the new features often improve security. If this is not an option, they can stay on the `v0.x` branch which will continue to be supported for bug fixes.
As seen on the table below, v1.0 will be the first version to drop support for very old filesystems (v0.6 and lower).
@@ -11,4 +13,8 @@ As seen on the table below, v1.0 will be the first version to drop support for v
| v0.5 | DirIV | - | Y | Y | Y | Y | Y | Y | - |
| v0.6 | DirIV, EMENames | - | - | Y | Y | Y | Y | Y | - |
| v0.7, v0.8 | DirIV, EMENames, GCMIV128 | - | - | - | Y | Y | Y | Y | Y |
-| v0.9, v0.10, v1.0 | DirIV, EMENames, GCMIV128, LongNames | - | - | - | - | - | Y | Y | Y | \ No newline at end of file
+| v0.9, v0.10, v1.0 | DirIV, EMENames, GCMIV128, LongNames | - | - | - | - | - | Y | Y | Y |
+
+### Upgrading
+
+Upgrading a filesystem simply means creating a new filesystem and copying all the data over. \ No newline at end of file