From: Stefan Kangas <stefan@marxist.se>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 44598@debbugs.gnu.org
Subject: bug#44598: [PATCH] Do not show obsolete options in customize
Date: Fri, 13 Nov 2020 09:10:52 -0800 [thread overview]
Message-ID: <CADwFkmkSAhK3rg2L6BfVChmkw8h=34Nx8rdZj1XxUfiyqtmsTw@mail.gmail.com> (raw)
In-Reply-To: <83mtzlya9n.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 791 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
> Thanks, some comments:
Thanks for commenting, as always.
Please find attached an updated patch that should fix all your comments.
> Do we really need the power of seq.el here? wouldn't mapcar do the job
> nicely, since we have a simple list here? OTOH, if you do use seq.el,
> why seq-filter and not seq-remove?
I think mapcar won't work since the returned list is the same length as
its input. seq-remove seems better indeed.
> This test will fail when we remove the obsolete option, right? How
> can we come up with a test that doesn't suffer from such maintenance
> problems?
This option is only defined in this file for testing purposes, and
should never be removed. I've clarified this in its docstring and added
a high version number.
[-- Attachment #2: 0001-Hide-obsolete-options-in-most-customize-commands.patch --]
[-- Type: text/x-diff, Size: 7067 bytes --]
From 58b144a805dd46b26db4fa266ac124af3146448e Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Sat, 24 Oct 2020 19:44:20 +0200
Subject: [PATCH] Hide obsolete options in most customize commands
* lisp/cus-edit.el (custom--filter-obsolete-variables): New defun.
* lisp/cus-edit.el (customize-changed-options)
(customize-apropos, custom-group-value-create): Hide obsolete user
options. (Bug#44598)
* test/lisp/cus-edit-tests.el: New file.
---
etc/NEWS | 10 +++++
lisp/cus-edit.el | 26 ++++++++----
test/lisp/cus-edit-tests.el | 80 +++++++++++++++++++++++++++++++++++++
3 files changed, 108 insertions(+), 8 deletions(-)
create mode 100644 test/lisp/cus-edit-tests.el
diff --git a/etc/NEWS b/etc/NEWS
index f21c4cb02c..fa9a87d80c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -706,6 +706,16 @@ This file was a compatibility kludge which is no longer needed.
To revert to the previous behavior,
'(setq lisp-indent-function 'lisp-indent-function)' from 'lisp-mode-hook'.
+** Customize
+
+*** Most customize commands now hides obsolete user options.
+Obsolete user options are no longer shown in the listings produced by
+the commands `customize', `customize-group', `customize-apropos' and
+`customize-changed-options'.
+
+To customize obsolete user options, use `customize-option' or
+`customize-saved'.
+
** Edebug
+++
diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el
index d1077d367d..b46be39e38 100644
--- a/lisp/cus-edit.el
+++ b/lisp/cus-edit.el
@@ -1298,7 +1298,8 @@ customize-changed-options
(if (custom-facep symbol)
(push (list symbol 'custom-face) found)))))))
(if found
- (custom-buffer-create (custom-sort-items found t 'first)
+ (custom-buffer-create (custom--filter-obsolete-variables
+ (custom-sort-items found t 'first))
"*Customize Changed Options*")
(user-error "No user option defaults have been changed since Emacs %s"
since-version))))
@@ -1504,7 +1505,8 @@ customize-apropos
(symbol-name type))
pattern))
(custom-buffer-create
- (custom-sort-items found t custom-buffer-order-groups)
+ (custom--filter-obsolete-variables
+ (custom-sort-items found t custom-buffer-order-groups))
"*Customize Apropos*")))
;;;###autoload
@@ -4232,6 +4234,13 @@ custom-group-visibility-create
(insert "--------")))
(widget-default-create widget))
+(defun custom--filter-obsolete-variables (items)
+ "Filter obsolete variables from ITEMS."
+ (seq-remove (lambda (item)
+ (and (eq (nth 1 item) 'custom-variable)
+ (get (nth 0 item) 'byte-obsolete-variable)))
+ items))
+
(defun custom-group-members (symbol groups-only)
"Return SYMBOL's custom group members.
If GROUPS-ONLY is non-nil, return only those members that are groups."
@@ -4437,12 +4446,13 @@ custom-group-value-create
?\s))
;; Members.
(message "Creating group...")
- (let* ((members (custom-sort-items
- members
- ;; Never sort the top-level custom group.
- (unless (eq symbol 'emacs)
- custom-buffer-sort-alphabetically)
- custom-buffer-order-groups))
+ (let* ((members (custom--filter-obsolete-variables
+ (custom-sort-items
+ members
+ ;; Never sort the top-level custom group.
+ (unless (eq symbol 'emacs)
+ custom-buffer-sort-alphabetically)
+ custom-buffer-order-groups)))
(prefixes (widget-get widget :custom-prefixes))
(custom-prefix-list (custom-prefix-add symbol prefixes))
(have-subtitle (and (not (eq symbol 'emacs))
diff --git a/test/lisp/cus-edit-tests.el b/test/lisp/cus-edit-tests.el
new file mode 100644
index 0000000000..4d148b4f41
--- /dev/null
+++ b/test/lisp/cus-edit-tests.el
@@ -0,0 +1,80 @@
+;;; cus-edit-tests.el --- Tests for cus-edit.el -*- lexical-binding: t -*-
+
+;; Copyright (C) 2020 Free Software Foundation, Inc.
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'ert)
+(require 'ert-x)
+(require 'cus-edit)
+
+(defmacro with-cus-edit-test (buffer &rest body)
+ (declare (indent 1))
+ `(save-window-excursion
+ (unwind-protect
+ (progn ,@body)
+ (when-let ((buf (get-buffer ,buffer)))
+ (kill-buffer buf)))))
+
+\f
+;;;; showing/hiding obsolete options
+
+(defgroup cus-edit-tests nil "test"
+ :group 'test-group)
+
+(defcustom cus-edit-tests--obsolete-option-tag nil
+ "This should never be removed; it is obsolete for testing purposes."
+ :type 'boolean
+ :version "917.10") ; a super high version number
+(make-obsolete-variable 'cus-edit-tests--obsolete-option-tag nil "X.X-test")
+(defconst cus-edit-tests--obsolete-option-tag
+ (custom-unlispify-tag-name 'cus-edit-tests--obsolete-option-tag))
+
+(ert-deftest cus-edit-tests-customize-apropos/hide-obsolete ()
+ (with-cus-edit-test "*Customize Apropos*"
+ (customize-apropos "cus-edit-tests")
+ (should-not (search-forward cus-edit-tests--obsolete-option-tag nil t))))
+
+(ert-deftest cus-edit-tests-customize-changed-options/hide-obsolete ()
+ (with-cus-edit-test "*Customize Changed Options*"
+ (customize-changed-options "917.2") ; some future version
+ (should-not (search-forward cus-edit-tests--obsolete-option-tag nil t))))
+
+(ert-deftest cus-edit-tests-customize-group/hide-obsolete ()
+ "Check that obsolete variables do not show up."
+ (with-cus-edit-test "*Customize Group: Cus Edit Tests*"
+ (customize-group 'cus-edit-tests)
+ (should-not (search-forward cus-edit-tests--obsolete-option-tag nil t))))
+
+(ert-deftest cus-edit-tests-customize-option/show-obsolete ()
+ (with-cus-edit-test "*Customize Option: Cus Edit Tests Obsolete Option Tag*"
+ (customize-option 'cus-edit-tests--obsolete-option-tag)
+ (goto-char (point-min))
+ (should (search-forward cus-edit-tests--obsolete-option-tag nil t))))
+
+(ert-deftest cus-edit-tests-customize-saved/show-obsolete ()
+ ;; FIXME: How to test for saved options?
+ :expected-result :failed
+ (with-cus-edit-test "*Customize Saved*"
+ (customize-saved)
+ (should (search-forward cus-edit-tests--obsolete-option-tag nil t))))
+
+(provide 'cus-edit-tests)
+;;; cus-edit-tests.el ends here
--
2.29.2
next prev parent reply other threads:[~2020-11-13 17:10 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-18 13:01 On obsoleting defcustoms Stefan Kangas
2020-09-18 13:28 ` Eli Zaretskii
2020-09-18 13:40 ` Stefan Kangas
2020-11-12 20:56 ` bug#44598: [PATCH] Do not show obsolete options in customize Stefan Kangas
2020-11-12 21:11 ` Basil L. Contovounesios
2020-11-12 21:39 ` Stefan Kangas
2020-11-12 22:18 ` Basil L. Contovounesios
2020-11-13 7:43 ` Eli Zaretskii
2020-11-12 21:40 ` Drew Adams
2020-11-12 21:44 ` Mauro Aranda
2020-11-12 22:08 ` Stefan Kangas
2020-11-12 22:41 ` Mauro Aranda
2020-11-13 7:48 ` Eli Zaretskii
2020-11-13 7:40 ` Eli Zaretskii
2020-11-13 17:10 ` Stefan Kangas [this message]
2020-11-14 14:22 ` Eli Zaretskii
2020-11-20 13:37 ` Stefan Kangas
[not found] <<CADwFkmm2G=OPOdgadhDk+1uCbHzuqpqaYDs1KgdDes7gXLYgxg@mail.gmail.com>
[not found] ` <<83lfh743j8.fsf@gnu.org>
2020-11-12 21:37 ` On obsoleting defcustoms Drew Adams
2020-11-12 21:54 ` Stefan Kangas
2020-11-12 22:16 ` Drew Adams
2020-11-13 0:07 ` Stefan Kangas
2020-11-13 1:59 ` Drew Adams
2020-11-13 3:10 ` Stefan Kangas
2020-11-13 5:18 ` Drew Adams
2020-11-13 8:16 ` Eli Zaretskii
2020-11-13 7:46 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkmkSAhK3rg2L6BfVChmkw8h=34Nx8rdZj1XxUfiyqtmsTw@mail.gmail.com' \
--to=stefan@marxist.se \
--cc=44598@debbugs.gnu.org \
--cc=eliz@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.