GNU bug report logs - #71812
[PATCH] Flag checkdoc-package-keywords-flag as a :safe variable

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 71812 in the body.
You can then email your comments to 71812 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: Jules Tamagnan <jtamagnan <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Flag checkdoc-package-keywords-flag as a :safe variable
Date: Thu, 27 Jun 2024 22:23:59 -0700

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

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'

[safe.patch (text/patch, attachment)]

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Jules Tamagnan <jtamagnan <at> gmail.com>, 71812-done <at> debbugs.gnu.org
Subject: Re: bug#71812: [PATCH] Flag checkdoc-package-keywords-flag as a :safe
 variable
Date: Fri, 28 Jun 2024 20:37:41 -0700

Version: 31.1

Jules Tamagnan <jtamagnan <at> gmail.com> writes:

> From 96c335bb5ab68b7fcf2d3079df15045ad79d19d3 Mon Sep 17 00:00:00 2001
> From: Jules Tamagnan <jtamagnan <at> 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

Thanks, installed on master as commit d3b100d4192.

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

From: Jules Tamagnan <jtamagnan <at> gmail.com>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 71812-done <at> debbugs.gnu.org
Subject: Re: bug#71812: [PATCH] Flag checkdoc-package-keywords-flag as a
 :safe variable
Date: Sat, 29 Jun 2024 14:07:28 -0700

Stefan Kangas <stefankangas <at> gmail.com> writes:

> Version: 31.1
>
> ...
>
> Thanks, installed on master as commit d3b100d4192.

Brilliant, thank you for the super quick response and integration. I
really appreciate it!

Best,
Jules

Previous Next

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