From: Jules Tamagnan <jtamagnan@gmail.com>
To: 71812@debbugs.gnu.org
Subject: bug#71812: [PATCH] Flag checkdoc-package-keywords-flag as a :safe variable
Date: Thu, 27 Jun 2024 22:23:59 -0700 [thread overview]
Message-ID: <87v81ttzbk.fsf@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 1443 bytes --]
Tags: patch
* Problem
Recently I was collaborating on a package that provided a .dir-locals.el
file where this `checkdoc-package-keywords-flag' was being set. I then
had to figure out what variable was considered unsafe and decide whether
it was unsafe or not. This caused some extra mental overhead and
development friction.
* Solution
It would be great if this variable were already considered safe to
reduce overhead on developers.
* Implementation
After looking at how this variable was used I noticed that it was only
consumed in `checkdoc-current-buffer' and that it seemed safe to mark as
safe. I added a single autoload line as is done throughout the rest of
the file for similar variables
---
Best,
Jules
---
In GNU Emacs 31.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
3.24.42, cairo version 1.18.0)
Repository revision: 9cb2a2040888c28587bed2b0902d9da90720f9a0
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101013
System Description: NixOS 24.11 (Vicuna)
Configured using:
'configure
--prefix=/nix/store/93m6yix8f6pcg75418xjx7k81lrj5a6s-emacs-git-20240626.0
--disable-build-details --with-modules --with-x-toolkit=gtk3
--with-cairo --with-xft --with-compress-install
--with-toolkit-scroll-bars --with-native-compilation
--without-imagemagick --with-mailutils --without-small-ja-dic
--with-tree-sitter --with-xinput2 --with-xwidgets --with-dbus
--with-selinux'
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: safe.patch --]
[-- Type: text/patch, Size: 926 bytes --]
From 96c335bb5ab68b7fcf2d3079df15045ad79d19d3 Mon Sep 17 00:00:00 2001
From: Jules Tamagnan <jtamagnan@gmail.com>
Date: Thu, 27 Jun 2024 22:04:58 -0700
Subject: [PATCH] Flag checkdoc-package-keywords-flag as a :safe variable
* lisp/emacs-lisp/checkdoc.el: Mark 'checkdoc-package-keywords-flag'
as a safe local variable.
---
lisp/emacs-lisp/checkdoc.el | 1 +
1 file changed, 1 insertion(+)
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index c22dfb2eb26..bda5150cf07 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -289,6 +289,7 @@ checkdoc-package-keywords-flag
Currently, all recognized keywords must be on `finder-known-keywords'."
:version "25.1"
:type 'boolean)
+;;;###autoload(put 'checkdoc-package-keywords-flag 'safe-local-variable #'booleanp)
(defvar checkdoc-style-functions nil
"Hook run after the standard style check is completed.
--
2.45.1
next reply other threads:[~2024-06-28 5:23 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-28 5:23 Jules Tamagnan [this message]
2024-06-29 3:37 ` bug#71812: [PATCH] Flag checkdoc-package-keywords-flag as a :safe variable Stefan Kangas
2024-06-29 21:07 ` Jules Tamagnan
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=87v81ttzbk.fsf@gmail.com \
--to=jtamagnan@gmail.com \
--cc=71812@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).