docs: add comments mentioning ensure_installed has no relation with automatic_installation

ensure_installed is used as a hard-coded list of servers to always
install, no matter if they're setup or not.

automatic_installation is used to automatically detect which servers
needs to be installed, based on which servers are setup via lspconfig.

3 files changed, 16 insertions, 2 deletions

diff --git a/README.md b/README.md
index ba1e6f58..27b6e442 100644
--- a/README.md
+++ b/README.md
@@ -164,7 +164,6 @@ Example:
 
 ```lua
 require("nvim-lsp-installer").setup({
-    ensure_installed = { "rust_analyzer", "sumneko_lua" }, -- ensure these servers are always installed
     automatic_installation = true, -- automatically detect which servers to install (based on which servers are set up via lspconfig)
     ui = {
         icons = {
@@ -319,15 +318,20 @@ Illustrations in the logo are derived from [@Kaligule](https://schauderbasis.de/
 ```lua
 local DEFAULT_SETTINGS = {
     -- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer", "sumneko_lua" }
+    -- This setting has no relation with the `automatic_installation` setting.
     ensure_installed = {},
+
     -- Whether servers that are set up (via lspconfig) should be automatically installed if they're not already installed.
+    -- This setting has no relation with the `ensure_installed` setting.
     -- Can either be:
     --   - false: Servers are not automatically installed.
     --   - true: All servers set up via lspconfig are automatically installed.
     --   - { exclude: string[] }: All servers set up via lspconfig, except the ones provided in the list, are automatically installed.
     --       Example: automatic_installation = { exclude = { "rust_analyzer", "solargraph" } }
     automatic_installation = false,
+
     ui = {
+
         icons = {
             -- The list icon to use for installed servers.
             server_installed = "◍",
diff --git a/doc/nvim-lsp-installer.txt b/doc/nvim-lsp-installer.txt
index ed8258b2..9625803d 100644
--- a/doc/nvim-lsp-installer.txt
+++ b/doc/nvim-lsp-installer.txt
@@ -176,15 +176,20 @@ The following settings are applied by default. >
 
     local DEFAULT_SETTINGS = {
         -- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer", "sumneko_lua" }
+        -- This setting has no relation with the `automatic_installation` setting.
         ensure_installed = {},
+
         -- Whether servers that are set up (via lspconfig) should be automatically installed if they're not already installed.
+        -- This setting has no relation with the `ensure_installed` setting.
         -- Can either be:
         --   - false: Servers are not automatically installed.
         --   - true: All servers set up via lspconfig are automatically installed.
         --   - { exclude: string[] }: All servers set up via lspconfig, except the ones provided in the list, are automatically installed.
         --       Example: automatic_installation = { exclude = { "rust_analyzer", "solargraph" } }
         automatic_installation = false,
+
         ui = {
+
             icons = {
                 -- The list icon to use for installed servers.
                 server_installed = "◍",
diff --git a/lua/nvim-lsp-installer/settings.lua b/lua/nvim-lsp-installer/settings.lua
index 92f80003..e346763f 100644
--- a/lua/nvim-lsp-installer/settings.lua
+++ b/lua/nvim-lsp-installer/settings.lua
@@ -4,16 +4,21 @@ local M = {}
 
 ---@class LspInstallerSettings
 local DEFAULT_SETTINGS = {
-    -- A list of servers to automatically install. Example: { "rust_analyzer", "sumneko_lua" }
+    -- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer", "sumneko_lua" }
+    -- This setting has no relation with the `automatic_installation` setting.
     ensure_installed = {},
+
     -- Whether servers that are set up (via lspconfig) should be automatically installed if they're not already installed.
+    -- This setting has no relation with the `ensure_installed` setting.
     -- Can either be:
     --   - false: Servers are not automatically installed.
     --   - true: All servers set up via lspconfig are automatically installed.
     --   - { exclude: string[] }: All servers set up via lspconfig, except the ones provided in the list, are automatically installed.
     --       Example: automatic_installation = { exclude = { "rust_analyzer", "solargraph" } }
     automatic_installation = false,
+
     ui = {
+
         icons = {
             -- The list icon to use for installed servers.
             server_installed = "◍",