unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 74267@debbugs.gnu.org
Subject: bug#74267: 29.4; Doc string of `add-file-local-variable`
Date: Fri, 8 Nov 2024 21:25:01 +0000	[thread overview]
Message-ID: <DS7PR10MB523245754CC72BA04D989AA6F35D2@DS7PR10MB5232.namprd10.prod.outlook.com> (raw)

The doc string doesn't make clear that it adds the variable
at the end of the file, and not on the first line (as a cookie).  This
is important in the case of a variable, such as `lexical-binding', that
must be added to the first line.

See, for example, this question:

https://emacs.stackexchange.com/q/82549/105

The user tried `M-x add-file-local-variable' and didn't understand the
error message, especially because point was at bob:

user-error: The 'lexical-binding' variable must be set at the start of the file

The Emacs manual, node Specifying File Variables makes everything clear.
But please clarify the doc string of `add-file-local-variable'.


In GNU Emacs 29.4 (build 2, x86_64-w64-mingw32) of 2024-07-05 built on
 AVALON
Windowing system distributor 'Microsoft Corp.', version 10.0.19045
System Description: Microsoft Windows 10 Pro (v10.0.2009.19045.5011)

Configured using:
 'configure --with-modules --without-dbus --with-native-compilation=aot
 --without-compress-install --with-sqlite3 --with-tree-sitter
 CFLAGS=-O2'

Configured features:
ACL GIF GMP GNUTLS HARFBUZZ JPEG JSON LCMS2 LIBXML2 MODULES NATIVE_COMP
NOTIFY W32NOTIFY PDUMPER PNG RSVG SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP XPM ZLIB

(NATIVE_COMP present but libgccjit not available)






             reply	other threads:[~2024-11-08 21:25 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-08 21:25 Drew Adams via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2024-11-09 12:04 ` bug#74267: 29.4; Doc string of `add-file-local-variable` Eli Zaretskii
2024-11-09 17:19   ` Drew Adams via Bug reports for GNU Emacs, the Swiss army knife of text editors

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=DS7PR10MB523245754CC72BA04D989AA6F35D2@DS7PR10MB5232.namprd10.prod.outlook.com \
    --to=bug-gnu-emacs@gnu.org \
    --cc=74267@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    /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).