From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#58893: 29.0.50; Feedback on Eglot manual Date: Sun, 30 Oct 2022 12:29:55 +0200 Message-ID: <83o7ttfvto.fsf@gnu.org> References: <874jvlk5pm.fsf@betli.tmit.bme.hu> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2645"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 58893@debbugs.gnu.org To: Felician Nemeth Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Oct 30 11:31:40 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1op5bQ-0000bT-GO for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 30 Oct 2022 11:31:40 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1op5bD-0003FL-A7; Sun, 30 Oct 2022 06:31:29 -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 1op5ao-0003DF-Tk for bug-gnu-emacs@gnu.org; Sun, 30 Oct 2022 06:31:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1op5ao-0005Ij-Lj for bug-gnu-emacs@gnu.org; Sun, 30 Oct 2022 06:31:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1op5ao-00008f-Gr for bug-gnu-emacs@gnu.org; Sun, 30 Oct 2022 06:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 30 Oct 2022 10:31:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 58893 X-GNU-PR-Package: emacs Original-Received: via spool by 58893-submit@debbugs.gnu.org id=B58893.1667125822480 (code B ref 58893); Sun, 30 Oct 2022 10:31:02 +0000 Original-Received: (at 58893) by debbugs.gnu.org; 30 Oct 2022 10:30:22 +0000 Original-Received: from localhost ([127.0.0.1]:37390 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1op5aA-00007f-7Z for submit@debbugs.gnu.org; Sun, 30 Oct 2022 06:30:22 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:52540) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1op5a7-00007P-HS for 58893@debbugs.gnu.org; Sun, 30 Oct 2022 06:30:20 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1op5a2-0005Ah-92; Sun, 30 Oct 2022 06:30:14 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=PVjTfuZHC3Nn6qC0JV9jtTYWW+bOQb7KCPEzX8dkLcM=; b=kb3geKeOP5EH NbM63LvtUpDMyA5AZ05znYDY41MyeZS98uWzvkKbBJpCrchvSZC2gruGUo2nS2/7YJ8cSOAkGWDK3 /+1CdSVZ0MJcohyu1gIdCuRPoR+aEXAprPKaRtyj4KrWZFPGW1o5TqL1BbwPPcTZfBMNxji5eoagv ldccLzhfLKg+8vb2Pb/dzX5G4qxlDjMp6eUn/phmPZ/bWqTeziuRZ6xUhYE1cXJvxv893xcWObrqR l+GCDwqQjFTnnYDx4JtrGFX1S6AonN3OcsecBH7R3dE02SCpZ0qw+wjXYRNMICDtkiWzOaS3P7plU oxIAsMpphA594cxBIXhc3Q==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1op5a1-0005RQ-Ng; Sun, 30 Oct 2022 06:30:14 -0400 In-Reply-To: <874jvlk5pm.fsf@betli.tmit.bme.hu> (message from Felician Nemeth on Sun, 30 Oct 2022 10:42:45 +0100) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: "bug-gnu-emacs" Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:246607 Archived-At: > From: Felician Nemeth > Date: Sun, 30 Oct 2022 10:42:45 +0100 > > I'm not sure whether it is necessary to document all the commands > defined by Eglot, but the manual mentions xref-find-definitions, so > probably it should call the reader's attention to > eglot-find-declaration, eglot-find-implementation, > eglot-find-typeDefinition, and xref-find-references as well. Xref-related Eglot features are already mentioned in the Emacs user manual, where Xref is described. Eglot is documented there as an additional backend for Xref. I think that's the right place for that to be documented. The Eglot-specific commands you mention are AFAIU direct calls to the Eglot's Xref backend, so why do we need to describe them in the manual, when Xref itself is already described? > * WorkspaceFolders > > The LSP protocol supports multiple workspace folders. Eglot relies on > project-external-roots to get the additional folders (besides > project-root). This is not mentioned in the manual. However, (info > "(emacs)Projects") doesn't talk about how the user should configure > these external roots. > > Maybe a simple solution is to rework the relevant part from NEWS.md into > the eglot.texi. NEWS.md has this: > > Eglot now advertises project-root and project-external-roots as > workspace-folders. (Configuring tags-table-list sets the external > roots of a simple git project.) I'm not sure what exactly are you proposing to mention in the manual in this respect. If we are going to add the description of how to add directories to a project, then yes, Eglot should be mentioned there (but only in passing, IMO, since Eglot follows the project settings automatically, AFAIU). But as long as we don't have such a description in the manual, how can we say anything in this respect about Eglot? > * Snippet completion > > Yasnippet should be enabled in the current buffer before Eglot connects > to the LSP server. That's a detail best left for README's, in particular that of Yasnippet, IMO. The manual mentions Yasnippet as an optional package, and leaves it at that, because it really isn't TRT to start describing unbundled packages in our manuals. Thanks.