From 2ca20b23638d8b2421c0e05a5fccb58fa3b4a065 Mon Sep 17 00:00:00 2001 From: Fred Snyder Date: Sun, 29 Dec 2019 23:38:15 -0500 Subject: [PATCH] Document SOLARGRAPH_CACHE in README. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3767c691c..549d1a75c 100755 --- a/README.md +++ b/README.md @@ -61,6 +61,12 @@ The Solargraph gem ships with documentation for Ruby 2.2.2. You can download doc $ solargraph download-core # Install the best match for your Ruby version $ solargraph clear # Reset the documentation cache +### The Documentation Cache + +Solargraph uses a cache directory to store documentation for the Ruby core and customized documentation for certain gems. The default location is `~/.solargraph/cache`, e.g., `/home//.solargraph/cache` on Linux or `C:\Users\\.solargraph` on Windows. + +You can change the location of the cache directory with the `SOLARGRAPH_CACHE` environment variable. This can be useful if you want the cache to comply with the XDG Base Directory Specification. + ### Solargraph and Bundler If you're using the language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.