GNU bug report logs - #78784
[PATCH] Improve the documentation of the internal Lisp_Process->status field

Previous Next

To reply to this bug, email your comments to 78784 AT debbugs.gnu.org.
There is no need to reopen the bug first.

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

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

From: Steven Allen <steven <at> stebalien.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Improve the documentation of the internal
 Lisp_Process->status field
Date: Fri, 13 Jun 2025 07:54:54 -0700

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

Tags: patch


Contrary to the existing documentation here, the value of this field
cannot be the symbols open or closed. Furthermore, this field is never
set to "stop" for network connections.

In GNU Emacs 31.0.50 (build 1, x86_64-pc-linux-gnu, cairo version
 1.18.4) of 2025-06-12 built on Laptop
Repository revision: 7bca4f75b1784c555f776910845fdb5c06224fc0
Repository branch: makepkg
Windowing system distributor 'The X.Org Foundation', version 11.0.12101016
System Description: Arch Linux

Configured using:
 'configure
 'CPPFLAGS=-I/run/user/1000/build/emacs-git/src/mps-git/build/include '
 'LDFLAGS=-L/run/user/1000/build/emacs-git/src/mps-git/build/lib -Wl,-O1
 -Wl,--sort-common -Wl,--as-needed -Wl,-z,relro -Wl,-z,now
 -Wl,-z,pack-relative-relocs -flto=auto' --prefix=/usr --sysconfdir=/etc
 --libexecdir=/usr/lib --localstatedir=/var --mandir=/usr/share/man
 --with-gameuser=:games --with-modules --without-m17n-flt
 --without-selinux --without-pop --without-gconf --disable-gc-mark-trace
 --with-mps=yes --enable-link-time-optimization
 --with-native-compilation=yes --with-xinput2 --with-x-toolkit=no
 --without-toolkit-scroll-bars --without-xaw3d --without-gsettings
 --with-cairo-xcb --without-xft --with-sound=no --with-tree-sitter
 --without-gpm --without-compress-install
 '--program-transform-name=s/\([ec]tags\)/\1.emacs/'
 'CFLAGS=-march=native -mtune=native -O3 -pipe -fno-plt -fexceptions
 -Wp,-D_FORTIFY_SOURCE=3 -Wformat -Werror=format-security
 -fstack-clash-protection -fcf-protection -fomit-frame-pointer
 -fno-math-errno -fno-trapping-math -flto=auto' 'CXXFLAGS=-march=native
 -mtune=native -O3 -pipe -fno-plt -fexceptions -Wp,-D_FORTIFY_SOURCE=3
 -Wformat -Werror=format-security -fstack-clash-protection
 -fcf-protection -fomit-frame-pointer -Wp,-D_GLIBCXX_ASSERTIONS
 -flto=auto''

[0001-Improve-the-documentation-of-the-internal-Lisp_Proce.patch (text/patch, attachment)]

Message #10 received at 78784-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Steven Allen <steven <at> stebalien.com>
Cc: 78784-done <at> debbugs.gnu.org
Subject: Re: bug#78784: [PATCH] Improve the documentation of the internal
 Lisp_Process->status field
Date: Sat, 14 Jun 2025 18:03:59 +0300

> Date: Fri, 13 Jun 2025 07:54:54 -0700
> From:  Steven Allen via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> Contrary to the existing documentation here, the value of this field
> cannot be the symbols open or closed. Furthermore, this field is never
> set to "stop" for network connections.

Thanks, installed on master, and closing the bug.

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

From: Richard Stallman <rms <at> gnu.org>
To: Steven Allen <steven <at> stebalien.com>
Cc: 78784 <at> debbugs.gnu.org
Subject: Re: bug#78784: [PATCH] Improve the documentation of the internal
 Lisp_Process->status field
Date: Sun, 15 Jun 2025 23:19:24 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > Contrary to the existing documentation here, the value of this field
  > cannot be the symbols open or closed. Furthermore, this field is never
  > set to "stop" for network connections.

This could be considered a bug in the documentation, or a bug in the code.
To tell which it is, is not automatic.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

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

From: Steven Allen <steven <at> stebalien.com>
To: rms <at> gnu.org
Cc: 78784 <at> debbugs.gnu.org
Subject: Re: bug#78784: [PATCH] Improve the documentation of the internal
 Lisp_Process->status field
Date: Sun, 15 Jun 2025 22:39:13 -0700

Richard Stallman <rms <at> gnu.org> writes:

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
>   > Contrary to the existing documentation here, the value of this field
>   > cannot be the symbols open or closed. Furthermore, this field is never
>   > set to "stop" for network connections.
>
> This could be considered a bug in the documentation, or a bug in the code.
> To tell which it is, is not automatic.

For network processes, the various status values are by
`process-status`: run -> open, exit -> closed, etc. Here I'm just
updating the internal documentation so contributors aren't confused
about why src/process.c never checks if a process's (internal) status is
open/closed/etc but instead only checks for run/exit/etc.

Effectively, "open" and "closed" are virtual states.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: rms <at> gnu.org
Cc: 78784 <at> debbugs.gnu.org, steven <at> stebalien.com
Subject: Re: bug#78784: [PATCH] Improve the documentation of the internal
 Lisp_Process->status field
Date: Mon, 16 Jun 2025 09:04:53 +0300

> Cc: 78784 <at> debbugs.gnu.org
> From: Richard Stallman <rms <at> gnu.org>
> Date: Sun, 15 Jun 2025 23:19:24 -0400
> 
>   > Contrary to the existing documentation here, the value of this field
>   > cannot be the symbols open or closed. Furthermore, this field is never
>   > set to "stop" for network connections.
> 
> This could be considered a bug in the documentation, or a bug in the code.
> To tell which it is, is not automatic.

I think it's a bug in the documentation, because someone looked at
what process-status can report and concluded (incorrectly) that the
same values are held internally in the process object.

Previous Next

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