GNU bug report logs - #68145
[PATCH] * doc/misc/eglot.texi: Fix broken function calls

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 68145 in the body.
You can then email your comments to 68145 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Vyacheslav Akhmechet <coffeemug <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] * doc/misc/eglot.texi: Fix broken function calls
Date: Sat, 30 Dec 2023 01:05:13 -0800

[Message part 1 (text/plain, inline)]

Tags: patch

Tags: patch

This patch fixes a broken example in the eglot manual. It makes two
changes:

* Fixes broken function calls
* Slightly simplifies overlay handling

Submitting this upon João Távora's suggestion.

In GNU Emacs 29.1 (build 2, aarch64-apple-darwin23.2.0, NS
 appkit-2487.30 Version 14.2.1 (Build 23C71)) of 2023-12-24 built on
 Vyacheslavs-MacBook-Pro.local
Windowing system distributor 'Apple', version 10.3.2487
System Description:  macOS 14.2.1

Configured using:
 'configure --disable-dependency-tracking --disable-silent-rules
 --enable-locallisppath=/opt/homebrew/share/emacs/site-lisp
 --infodir=/opt/homebrew/Cellar/emacs-plus <at> 29/29.1/share/info/emacs
 --prefix=/opt/homebrew/Cellar/emacs-plus <at> 29/29.1 --with-xml2
 --with-gnutls --with-native-compilation --without-compress-install
 --without-dbus --without-imagemagick --with-modules --with-rsvg
 --with-ns --disable-ns-self-contained 'CFLAGS=-Os -w -pipe
 -mmacosx-version-min=14
 -isysroot/Library/Developer/CommandLineTools/SDKs/MacOSX14.sdk
 -DFD_SETSIZE=10000 -DDARWIN_UNLIMITED_SELECT'
 'CPPFLAGS=-I/opt/homebrew/opt/zlib/include
 -I/opt/homebrew/opt/jpeg/include -I/opt/homebrew/opt/icu4c/include
 -isystem/opt/homebrew/include -F/opt/homebrew/Frameworks
 -isysroot/Library/Developer/CommandLineTools/SDKs/MacOSX14.sdk'
 'LDFLAGS=-L/opt/homebrew/opt/zlib/lib -L/opt/homebrew/opt/jpeg/lib
 -L/opt/homebrew/opt/icu4c/lib -L/opt/homebrew/lib
 -F/opt/homebrew/Frameworks -Wl,-headerpad_max_install_names
 -isysroot/Library/Developer/CommandLineTools/SDKs/MacOSX14.sdk
 -L/opt/homebrew/opt/libgccjit/lib''

[0001-doc-misc-eglot.texi-Fix-broken-function-calls.patch (text/patch, attachment)]

Message #8 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Felician Nemeth <felician.nemeth <at> gmail.com>
To: Vyacheslav Akhmechet <coffeemug <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, joaotavora <at> gmail.com
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Sat, 30 Dec 2023 14:45:54 +0100

Vyacheslav Akhmechet <coffeemug <at> gmail.com> writes:

> -  (if-let* ((path (expand-file-name (eglot-uri-to-path
> +  (if-let* ((path (expand-file-name (eglot--uri-to-path

The latest Eglot has this:

(define-obsolete-function-alias 'eglot--uri-to-path 'eglot-uri-to-path "1.16")

The confusion might come from the fact that ELPA had v1.16 for a brief
period, but now (for some strange reason) only v1.15 is available.

Message #11 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: João Távora <joaotavora <at> gmail.com>
To: Felician Nemeth <felician.nemeth <at> gmail.com>,
 Stefan Kangas <stefankangas <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Vyacheslav Akhmechet <coffeemug <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Sat, 30 Dec 2023 14:46:31 +0000

On Sat, Dec 30, 2023 at 1:45 PM Felician Nemeth
<felician.nemeth <at> gmail.com> wrote:
>
> Vyacheslav Akhmechet <coffeemug <at> gmail.com> writes:
>
> > -  (if-let* ((path (expand-file-name (eglot-uri-to-path
> > +  (if-let* ((path (expand-file-name (eglot--uri-to-path
>
> The latest Eglot has this:
>
> (define-obsolete-function-alias 'eglot--uri-to-path 'eglot-uri-to-path "1.16")
>
> The confusion might come from the fact that ELPA had v1.16 for a brief
> period, but now (for some strange reason) only v1.15 is available.

Strange indeed.  No idea what happened, but the 1.16 tarball is also
available:

https://elpa.gnu.org/packages/eglot-1.16.tar.lz

Stefan, can you see about this.

Vyacheslav, Felicián is correct.  Don't suggest '--' version of
functions in the manuals.  The remaining simplification is
welcome.  Don't use the symbol name 'inactive--code' though,
the '--' means "private".  That symbol can be "inactive-code"
or 'my-inactive-code' or even 'my-extension--inactive-code'.
Here though, "inactive-code" is preferable for demonstration
purposes.

João

Message #14 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: João Távora <joaotavora <at> gmail.com>, 
 Felician Nemeth <felician.nemeth <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Vyacheslav Akhmechet <coffeemug <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Sat, 30 Dec 2023 10:16:44 -0800

João Távora <joaotavora <at> gmail.com> writes:

> On Sat, Dec 30, 2023 at 1:45 PM Felician Nemeth
> <felician.nemeth <at> gmail.com> wrote:
>>
>> Vyacheslav Akhmechet <coffeemug <at> gmail.com> writes:
>>
>> > -  (if-let* ((path (expand-file-name (eglot-uri-to-path
>> > +  (if-let* ((path (expand-file-name (eglot--uri-to-path
>>
>> The latest Eglot has this:
>>
>> (define-obsolete-function-alias 'eglot--uri-to-path 'eglot-uri-to-path "1.16")
>>
>> The confusion might come from the fact that ELPA had v1.16 for a brief
>> period, but now (for some strange reason) only v1.15 is available.
>
> Strange indeed.  No idea what happened, but the 1.16 tarball is also
> available:
>
> https://elpa.gnu.org/packages/eglot-1.16.tar.lz
>
> Stefan, can you see about this.

I'm assuming the scripts bugged out.  I'm copying in the other Stefan,
since he has access to the server where this all runs.

The simplest solution in this case is probably to just bump the version
to 1.17, but that won't stop this from happening again in the future.

> Vyacheslav, Felicián is correct.  Don't suggest '--' version of
> functions in the manuals.  The remaining simplification is
> welcome.  Don't use the symbol name 'inactive--code' though,
> the '--' means "private".  That symbol can be "inactive-code"
> or 'my-inactive-code' or even 'my-extension--inactive-code'.
> Here though, "inactive-code" is preferable for demonstration
> purposes.
>
> João

Message #17 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Slava Akhmechet <coffeemug <at> gmail.com>
To: João Távora <joaotavora <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Felician Nemeth <felician.nemeth <at> gmail.com>,
 Stefan Kangas <stefankangas <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Sat, 30 Dec 2023 12:32:17 -0800

[Message part 1 (text/plain, inline)]

On Sat, Dec 30, 2023 at 6:46 AM João Távora <joaotavora <at> gmail.com> wrote:
> The remaining simplification is welcome.

Ack. Attached is a small patch that just cleans up overlay handling.

[Message part 2 (text/html, inline)]

[0001-doc-misc-eglot.texi-Simplify-overlay-handling.patch (application/octet-stream, attachment)]

Message #20 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Felician Nemeth <felician.nemeth <at> gmail.com>,
 João Távora <joaotavora <at> gmail.com>,
 Vyacheslav Akhmechet <coffeemug <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Mon, 01 Jan 2024 13:17:35 -0500

>> Strange indeed.  No idea what happened, but the 1.16 tarball is also
>> available:

I think the previous run of "update packages" was killed (timeout? OOM?)
and left the Git tree in an incorrect state (more specifically in
a detached state pointing at some old commit where Eglot happened to
still be at 1.15).
I've seen such problem sin the past and have tried to make the scripts
more robust in the face of such weird states, but it's hard to know
how/where to handle it.  I fixed it by hand this time, and added
yet-another sanity check elsewhere to help me catch or fix it, so
hopefully in won't re-occur.


        Stefan

Message #23 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Slava Akhmechet <coffeemug <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Felician Nemeth <felician.nemeth <at> gmail.com>,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Thu, 11 Jan 2024 12:58:07 -0800

Slava Akhmechet <coffeemug <at> gmail.com> writes:

> On Sat, Dec 30, 2023 at 6:46 AM João Távora <joaotavora <at> gmail.com> wrote:
>> The remaining simplification is welcome.
>
> Ack. Attached is a small patch that just cleans up overlay handling.

João, could you install this patch if you think it looks good?

Thanks in advance.

Message #26 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: João Távora <joaotavora <at> gmail.com>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Felician Nemeth <felician.nemeth <at> gmail.com>,
 Slava Akhmechet <coffeemug <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Thu, 11 Jan 2024 21:52:08 +0000

close 68145
thanks

On Thu, Jan 11, 2024 at 8:58 PM Stefan Kangas <stefankangas <at> gmail.com> wrote:
>
> Slava Akhmechet <coffeemug <at> gmail.com> writes:
>
> > On Sat, Dec 30, 2023 at 6:46 AM João Távora <joaotavora <at> gmail.com> wrote:
> >> The remaining simplification is welcome.
> >
> > Ack. Attached is a small patch that just cleans up overlay handling.
>
> João, could you install this patch if you think it looks good?
>
> Thanks in advance.

Done in bfb486d8026424ec0859036b3686df9cab1383df

João

Message #29 received at 68145 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: João Távora <joaotavora <at> gmail.com>
Cc: 68145 <at> debbugs.gnu.org, Felician Nemeth <felician.nemeth <at> gmail.com>,
 Slava Akhmechet <coffeemug <at> gmail.com>
Subject: Re: bug#68145: [PATCH] * doc/misc/eglot.texi: Fix broken function
 calls
Date: Sat, 13 Jan 2024 04:56:31 -0600

close 68145
thanks

João Távora <joaotavora <at> gmail.com> writes:

> close 68145
> thanks

That only works if you Bcc control <at> debbugs.gnu.org.  I did that here.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.