From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Robert Pluim Newsgroups: gmane.emacs.devel Subject: eglot manual suggestions Date: Mon, 24 Oct 2022 18:00:35 +0200 Message-ID: <87bkq1qkik.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22611"; mail-complaints-to="usenet@ciao.gmane.io" To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Oct 24 18:39:29 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1on0U4-0005kD-Rr for ged-emacs-devel@m.gmane-mx.org; Mon, 24 Oct 2022 18:39:28 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1omztV-00015y-9F; Mon, 24 Oct 2022 12:01:41 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1omzsY-0000pV-P9 for emacs-devel@gnu.org; Mon, 24 Oct 2022 12:00:46 -0400 Original-Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1omzsW-00066n-OX for emacs-devel@gnu.org; Mon, 24 Oct 2022 12:00:42 -0400 Original-Received: by mail-wm1-x32e.google.com with SMTP id az22-20020a05600c601600b003c6b72797fdso6913557wmb.5 for ; Mon, 24 Oct 2022 09:00:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date :gmane-reply-to-list:subject:to:from:from:to:cc:subject:date :message-id:reply-to; bh=pbC6lb5TFpcFmkYKZn1tJjWVK6QMcNfj4/CI66xTplk=; b=pVPN+EyKB1+Hy9lTZUSKuz0yohJneC7ibDkbRWyEb6fhyAHzX6z5TCYg0Y/v3CdKzr EHXZWxU8URlYIhRkP30RF447Zm2gUMk2gISX2W8D2gPUdZUbXhswVRSU55m/FS7O1EHi UNP9TszesQuvpJ5bPn2/5XE3lSnq2m1drjE9ikKVajpETffjzl+XJ5qY6uBKncfXiaro GbNQfvz71mCYe47WjJpnKkmMn9f4yVCjFng7wAHC+pllvVdpaj1SbfObgUmCG1w1idsj EJ4LMfzbMzvAUrfz0pNiNobpGL4uOMZuj34tHrNH0xYpLTZ6dfryNJ8lo3o7q81WIUfO YQHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date :gmane-reply-to-list:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=pbC6lb5TFpcFmkYKZn1tJjWVK6QMcNfj4/CI66xTplk=; b=ZQhpCWkIYhaKAlyIolF3ZMnyXmqNhSyYuOo8ve5aXkE2uwOQdcK7iilGeCcIvs9xHB jpF7T1oCFXeTnjOqpURnaWK1R7U1Sdg2179ye6/PImFTrvNw/GplfX3rPr5WBBhA6ofO vjazgsGyHZ7hIJQcznO1lA1HUcMMatYNQ3tkA+f+M41i6+xKWeLDG5M3V6MxJzYP6Vn4 x0YDlBs2VfmrUhUPm8sTIpRe0DyKj87K3fu/LU11RiVeT4yZuoWbrcWEl+ELPMWXrTSO TUptrcPyHGD2gwV169wofWkPih7hqqKhrjv/2/n231SEtxR4JuTCddtWtbHX5FtWgaaz EmFQ== X-Gm-Message-State: ACrzQf3X5ExH5+6Sk02y2CexXIOhpTxz+KUKKxvJ4KCGmhi5ua2EF4La q9SU7yZIDBFiX/NuD77OLzRqlhIxwGM= X-Google-Smtp-Source: AMsMyM4NNF9IWGA/xUqZumGfYQKdAk0/3nWI7h39qjQX5SP2lG+wTi6W2vSu60ggODe5J6p866gQFw== X-Received: by 2002:a05:600c:6028:b0:3c6:f0bb:316a with SMTP id az40-20020a05600c602800b003c6f0bb316amr31901353wmb.1.1666627237666; Mon, 24 Oct 2022 09:00:37 -0700 (PDT) Original-Received: from rltb ([82.66.8.55]) by smtp.gmail.com with ESMTPSA id k13-20020a5d6d4d000000b0022ac38fb20asm27190257wri.111.2022.10.24.09.00.35 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Oct 2022 09:00:36 -0700 (PDT) Gmane-Reply-To-List: yes Received-SPF: pass client-ip=2a00:1450:4864:20::32e; envelope-from=rpluim@gmail.com; helo=mail-wm1-x32e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: "Emacs-devel" Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:298385 Archived-At: Normally, I=CA=BCd just commit this, but I feel the Grammar Dragon has been poked enough for one week. I care not a whit if these are characterised as 'style changes' or 'grammar corrections', but I feel they are improvements. diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi index 0d82239c58..c90de7b84d 100644 --- a/doc/misc/eglot.texi +++ b/doc/misc/eglot.texi @@ -525,7 +525,7 @@ Eglot and Buffers Manual}). @end itemize =20 -Eglot uses the Emacs's project management infrastructure to figure out +Eglot uses the Emacs project management infrastructure to figure out which files and buffers belong to what project, so any kind of project supported by that infrastructure is automatically supported by Eglot. =20 @@ -588,8 +588,8 @@ Eglot and Buffers (@pxref{Eglot Features}) to receive information from the language server, by changing the settings of these features. Unlike other minor-modes, this special minor mode is not activated manually by the -user, but automatically as result of starting an Eglot session for the -buffer. However, this minor mode provides a hook variable +user, but automatically, as the result of starting an Eglot session +for the buffer. However, this minor mode provides a hook variable @code{eglot-managed-mode-hook} that can be used to customize the Eglot management of the buffer. This hook is run both when the minor mode is turned on and when it's turned off; use the variable @@ -614,7 +614,7 @@ Eglot Commands @section Eglot Commands @cindex commands, Eglot =20 -This section provides a reference of the most commonly used Eglot +This section provides a reference for the most commonly used Eglot commands: =20 @ftable @code @@ -672,7 +672,7 @@ Eglot Commands @item M-x eglot-rename This command renames the program symbol (a.k.a.@: @dfn{identifier}) at point to another name. It prompts for the new name of the symbol, and -then modifies all the files in the project which arte managed by the +then modifies all the files in the project which are managed by the language server of the current buffer to implement the renaming. =20 @item M-x eglot-format @@ -775,13 +775,13 @@ Eglot Variables @section Eglot Variables @cindex variables, Eglot =20 -This section provides a reference of the Eglot' user options. +This section provides a reference for the Eglot user options. =20 @vtable @code @item eglot-autoreconnect This option controls the ability to reconnect automatically to the language server when Eglot detects that the server process terminated -unexpectedly. The default value 3 means to attempt reconnection only +unexpectedly. The default value @code{3} means to attempt reconnection on= ly if the previous successful connection lasted for more than that number of seconds; a different positive value changes the minimal length of the connection to trigger reconnection. A value of @code{t} means @@ -798,7 +798,7 @@ Eglot Variables This setting is mainly important for connections which are slow to establish. Whereas the variable @code{eglot-connect-timeout} controls how long to wait for, this variable controls whether to block Emacs's -user interface while waiting. The default value is 3; a positive +user interface while waiting. The default value is @code{3}; a positive value means block for that many seconds, then wait for the connection in the background. The value of @code{t} means block during the whole waiting period. The value of @code{nil} or zero means don't block at @@ -885,7 +885,7 @@ Customizing Eglot @code{eldoc-display-functions}. @end itemize =20 -For this reason, this manual describes only how to customize the +For this reason, this manual describes only how to customize Eglot's own operation, which mainly has to do with the server connections and the server features to be used by Eglot. =20 @@ -919,12 +919,12 @@ Customizing Eglot @vindex eglot-stay-out-of @item eglot-stay-out-of This variable's value lists Emacs features that Eglot shouldn't -automatically try to manage on user's behalf. It is useful, for +automatically try to manage on the user's behalf. It is useful, for example, when you need to use non-LSP Flymake or Company back-ends. -To have Eglot stay away of some Emacs feature, add that feature's +To have Eglot stay away from some Emacs feature, add that feature's symbol or a regexp that will match a symbol's name to the list: for example, the symbol @code{xref} to leave Xref alone, or the string -@samp{company} to stay away of your Company customizations. Here's an +@samp{company} to stay away from your Company customizations. Here's an example: =20 @lisp @@ -949,7 +949,7 @@ Customizing Eglot settings contained in this variable to each server for which such settings were defined in the variable. These settings are communicated to the server initially (upon establishing the -connection) or when the settings are changed, or in response to the +connection) or when the settings are changed, or in response to a configuration request from the server. =20 In many cases, servers can be configured globally using a @@ -958,12 +958,12 @@ Customizing Eglot @command{pylsp} server for Python reads the file @file{~/.config/pycodestyle} and the @command{clangd} server reads the file @file{.clangd} anywhere in the current project's directory tree. -If possible, we recommend to use these configuration files that are +If possible, we recommend to use those configuration files that are independent of Eglot and Emacs; they have the advantage that they will work with other LSP clients as well. =20 If you do need to provide Emacs-specific configuration for a language -server, we recommend to define the appropriate value in the +server, we recommend defining the appropriate value in the @file{.dir-locals.el} file in the project's directory. The value of this variable should be a property list of the following format: =20 @@ -1104,9 +1104,9 @@ Troubleshooting Eglot backtrace of the error that should also be attached to the bug report. =20 @item -An explanation how to obtain and install the language server you used. -If possible, try to replicate the problem with the C/C@t{++} or Python -servers, as these are very easy to install. +An explanation of how to obtain, install, and configure the language +server you used. If possible, try to replicate the problem with the +C/C@t{++} or Python servers, as these are very easy to install. =20 @item A description of how to setup the @emph{minimal} project (one or two