From 45c27d59ee40f3945837ea827f29f6896414157f Mon Sep 17 00:00:00 2001
From: ebiggers <ebiggers@google.com>
Date: Thu, 23 Jan 2020 13:46:18 -0800
Subject: Document how to check for kernel config options (#183)

Resolves https://github.com/google/fscrypt/issues/181
---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b815807..64d8028 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,11 @@ enabled in the on-disk filesystem superblock:
   must have either `CONFIG_FS_ENCRYPTION=y` (for kernels v5.1+) or
   `CONFIG_UBIFS_FS_ENCRYPTION=y` (for older kernels).
 
+To check whether the needed option is enabled in your kernel, run:
+```shell
+zgrep -h ENCRYPTION /proc/config.gz /boot/config-$(uname -r) | sort | uniq
+```
+
 Be careful when using encryption on removable media, since filesystems with the
 `encrypt` feature cannot be mounted on systems with kernel versions older than
 the minimums listed above -- even to access unencrypted files!
-- 
cgit v1.2.3