From: Adam Porter <adam@alphapapa.net>
To: 67823@debbugs.gnu.org
Subject: bug#67823: 29.1; Multisession Variables documentation mistake
Date: Thu, 14 Dec 2023 05:08:13 -0600 [thread overview]
Message-ID: <22bf33d4-76b5-4b18-9756-37da3ccfe07b@alphapapa.net> (raw)
[-- Attachment #1: Type: text/plain, Size: 211 bytes --]
Hi,
I noticed that the manual section on Multisession Variables seems to
have a minor mistake in that one of the symbol names in the example code
seems to be wrong. Please see the attached patch.
Thanks,
Adam
[-- Attachment #2: variables.texi.patch --]
[-- Type: text/x-patch, Size: 1873 bytes --]
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 5de5ac6efa7..b4c6d8ac5c3 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -2971,7 +2971,7 @@ Multisession Variables
@lisp
@group
-(define-multisession-variable foo-var 0)
+(define-multisession-variable foo 0)
(defun my-adder (num)
(interactive "nAdd number: ")
(setf (multisession-value foo)
@@ -2981,7 +2981,7 @@ Multisession Variables
@end lisp
@noindent
-This defines the variable @code{foo-var} and binds it to a special
+This defines the variable @code{foo} and binds it to a special
multisession object which is initialized with the value @samp{0} (if
the variable doesn't already exist from a previous session). The
@code{my-adder} command queries the user for a number, adds this to
@@ -3004,7 +3004,7 @@ Multisession Variables
@var{package-symbol} isn't given, this will default to the first
``segment'' of the @var{name} symbol's name, which is the part of its
name up to and excluding the first @samp{-}. For instance, if
-@var{name} is @code{foo-var} and @var{package-symbol} isn't given,
+@var{name} is @code{foo} and @var{package-symbol} isn't given,
@var{package-symbol} will default to @code{foo}.
@cindex synchronized multisession variables
@@ -3012,7 +3012,7 @@ Multisession Variables
Multisession variables can be @dfn{synchronized} if @var{bool} is
non-@code{nil}. This means that if there're two concurrent Emacs
instances running, and the other Emacs changes the multisession
-variable @code{foo-var}, the current Emacs instance will retrieve that
+variable @code{foo}, the current Emacs instance will retrieve that
modified data when accessing the value. If @var{synchronized} is
@code{nil} or missing, this won't happen, and the values in all
Emacs sessions using the variable will be independent of each other.
next reply other threads:[~2023-12-14 11:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-14 11:08 Adam Porter [this message]
2023-12-14 22:37 ` bug#67823: 29.1; Multisession Variables documentation mistake Stefan Kangas
2023-12-15 0:31 ` Adam Porter
2023-12-15 0:55 ` Stefan Kangas
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=22bf33d4-76b5-4b18-9756-37da3ccfe07b@alphapapa.net \
--to=adam@alphapapa.net \
--cc=67823@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).