deploy: 2b6b899

page/adding-new-language/index.html

@@ -3263,6 +3263,16 @@ <h2 id="registering-server">Registering server<a class="headerlink" href="#regis
 <p><code>lsp-mode</code> is using <code>lsp-language-id-configuration</code> to determine what is the
 buffer language. When the <code>major-mode</code> is not sufficient to determine the
 language (e.g. <code>web-mode</code> is used for <code>javascript</code>, <code>html</code>, and <code>css</code>) you can put regex.</p>
+<p><strong>Note:</strong> In the above example, when a new client is created using
+<code>make-lsp-client</code>, a new connection to the language server is created
+using <code>lsp-stdio-connection</code>.  Please carefully check its
+documentation, as the function checks for various things (e.g. testing
+for the executable in PATH) and handles respective errors.  Often
+while adding a server, the LSP client author might do these checks
+themselves, but without handling the errors correctly.  This leads to
+features like <code>lsp-install-server</code> breaking for other users; e.g. see
+<a href="https://github.com/emacs-lsp/lsp-mode/issues/3415">this issue</a>.  This
+is a common mistake that keeps reoccurring.</p>
 <p>Here's an example of how to set up a custom language server in your <code>init.el</code> file:</p>
 <div class="highlight"><pre><span></span><code><span class="c1">;; Use shopify-cli / theme-check-language-server for Shopify&#39;s liquid syntax</span>
 <span class="p">(</span><span class="nb">with-eval-after-load</span> <span class="ss">&#39;lsp-mode</span>