From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#60470: 26.3; Doc string of `recentf-keep' Date: Mon, 02 Jan 2023 15:00:15 +0200 Message-ID: <83r0wd1480.fsf@gnu.org> References: <83pmby2lfd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8888"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 60470-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Jan 02 14:01:28 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pCKRU-00027C-Ao for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 02 Jan 2023 14:01:28 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pCKRM-0005vQ-Su; Mon, 02 Jan 2023 08:01:20 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pCKR4-0005rj-LB for bug-gnu-emacs@gnu.org; Mon, 02 Jan 2023 08:01:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pCKR4-00077t-A3 for bug-gnu-emacs@gnu.org; Mon, 02 Jan 2023 08:01:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pCKR4-0002Ns-5H for bug-gnu-emacs@gnu.org; Mon, 02 Jan 2023 08:01:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 02 Jan 2023 13:01:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60470 X-GNU-PR-Package: emacs Original-Received: via spool by 60470-done@debbugs.gnu.org id=D60470.16726644189084 (code D ref 60470); Mon, 02 Jan 2023 13:01:02 +0000 Original-Received: (at 60470-done) by debbugs.gnu.org; 2 Jan 2023 13:00:18 +0000 Original-Received: from localhost ([127.0.0.1]:42722 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pCKQM-0002MR-9j for submit@debbugs.gnu.org; Mon, 02 Jan 2023 08:00:18 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:49574) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pCKQK-0002M9-MB for 60470-done@debbugs.gnu.org; Mon, 02 Jan 2023 08:00:17 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pCKQE-0006xw-Nh; Mon, 02 Jan 2023 08:00:10 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=k/yEf/ezextYYo7yPzuZz0BwBVSiz177aJd5+dsB/fc=; b=oLda++TTXB4RAC2JX9Io yhCVyaFdTR0lCI7QBF97Vr5INV2N14n18c+dQdZVffPraq69hb0AtqJlDrIq2Q1H7RK0xLu0f+zfE YPh0otHw9oUF5946wzHamoiBto45Qm5F1y5UMwXj+68zo25L20nmuw9dALm9ShGiCiBvH1lfbBNV8 e+80+FsTBq1PaoAE495x60ipJXHh9u39H9XCTKhEPxKJDFyAsjU8jJZy0VEb6l0cKwiWG5Q7PfUyW kRsR4qa7nR/uO1dT/fds1eHliqGUEiRh1VJ7UGxHDdpZE40ZCBuzcOpNSePJuOgrZOsXC8XJ+GyQ1 2KoRk2kk0w1Jdg==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pCKQD-0001jF-0I; Mon, 02 Jan 2023 08:00:10 -0500 In-Reply-To: (message from Drew Adams on Sun, 1 Jan 2023 22:31:55 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:252336 Archived-At: > From: Drew Adams > CC: "60470-done@debbugs.gnu.org" <60470-done@debbugs.gnu.org> > Date: Sun, 1 Jan 2023 22:31:55 +0000 > > > I've rad the doc string, and I see nothing wrong with it. In > > particular, I did find there the explanation of what "keeping" means. > > > > So I'm closing this bug. > > FWIW, I don't see any such explanation, in any doc string. Here it is: List of regexps and predicates for filenames kept in the recent list. > Other than searching thus in the code, I see no way for a > user to know what "keep" means. Does it refer to keeping > persistently, i.e., not removing when saving? Does it > refer to keeping after the buffer for the file is killed? > When a "cleanup" occurs? "Keep" in what way, wrt what? Here's the answer: (define-minor-mode recentf-mode "Toggle keeping track of opened files (Recentf mode). This mode maintains a list of recently opened files and makes it easy to visit them. The recent files list is automatically saved across Emacs sessions. There's also a short explanation in the user manual: If you enable Recentf mode, with ‘M-x recentf-mode’, Emacs maintains a list of recently opened files. To open a file from this list, use the ‘M-x recentf-open’ command. When this mode is enabled, the ‘File’ menu will include a submenu that you can use to visit one of these files. ‘M-x recentf-save-list’ saves the current ‘recentf-list’ to a file, and ‘M-x recentf-edit-list’ edits it. > We give users two options for filtering the recentf list. > The doc string of one seems clear enough: it prevents > some file names _from being added_ to the list. The > other doc string doesn't speak to the presumed _removal_ > operations for which it prevents removal. Its predicates > and regexps prevent removal of certain files - but what > is it that would otherwise cause their removal? The original report didn't mention recentf-exclude. Since you now add it to the issue, I've looked that up: (defcustom recentf-exclude nil "List of regexps and predicates for filenames excluded from the recent list. When a filename matches any of the regexps or satisfies any of the predicates it is excluded from the recent list. A predicate is a function that is passed a filename to check and that must return non-nil to exclude it." Sounds perfectly clear to me, and the difference between recentf-keep and recentf-exclude is also very clear. > Would you mind pointing to the part of the doc string > that you think explains what "keeping" means? I really > don't see it. See above.