Fix #783 - Do not run Flow with home directory configuration files by default

1 files changed, 11 insertions, 0 deletions

diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt
index 1b8e3f5d..5a2969a1 100644
--- a/doc/ale-javascript.txt
+++ b/doc/ale-javascript.txt
@@ -84,6 +84,17 @@ g:ale_javascript_flow_executable             *g:ale_javascript_flow_executable*
   See |ale-integrations-local-executables|
 
 
+g:ale_javascript_flow_use_home_config   *g:ale_javascript_flow_use_home_config*
+                                        *b:ale_javascript_flow_use_home_config*
+  Type: |Number|
+  Default: `0`
+
+  When set to `1`, ALE will allow Flow to be executed with configuration files
+  from your home directory. ALE will not run Flow with home directory
+  configuration files by default, as doing so can lead to Vim consuming all of
+  your RAM and CPU power.
+
+
 g:ale_javascript_flow_use_global             *g:ale_javascript_flow_use_global*
                                              *b:ale_javascript_flow_use_global*
   Type: |Number|