From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#60470: 26.3; Doc string of `recentf-keep' Date: Sun, 1 Jan 2023 22:31:55 +0000 Message-ID: References: <83pmby2lfd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35188"; mail-complaints-to="usenet@ciao.gmane.io" Cc: "60470-done@debbugs.gnu.org" <60470-done@debbugs.gnu.org> To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jan 01 23:33:14 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 1pC6tF-0008ue-EM for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Jan 2023 23:33:13 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pC6t6-0005DF-Kx; Sun, 01 Jan 2023 17:33:05 -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 1pC6t4-0005Co-NP for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 17:33:02 -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 1pC6t4-0000gu-FS for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 17:33:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pC6t4-0003u0-BZ for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 17:33:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 01 Jan 2023 22:33: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.167261232614927 (code D ref 60470); Sun, 01 Jan 2023 22:33:02 +0000 Original-Received: (at 60470-done) by debbugs.gnu.org; 1 Jan 2023 22:32:06 +0000 Original-Received: from localhost ([127.0.0.1]:41972 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pC6s9-0003sg-Sg for submit@debbugs.gnu.org; Sun, 01 Jan 2023 17:32:06 -0500 Original-Received: from mx0a-00069f02.pphosted.com ([205.220.165.32]:14566) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pC6s6-0003sG-PZ for 60470-done@debbugs.gnu.org; Sun, 01 Jan 2023 17:32:03 -0500 Original-Received: from pps.filterd (m0246617.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 301LmbbT010678; Sun, 1 Jan 2023 22:32:00 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=corp-2022-7-12; bh=3zwAa0t4mPGp6xDuZG1MnKkI6TzWvG49GfuWNraynko=; b=noGTI0883e+axTkoK+tsUrwcusI1PCiKA6AZ92UjxiJR5t2ju88m/5eturUnNlSBnFUU Y1x8e/dpCKVYeUywVdkVF/zhaxpm18S7SMRwSGbFDrKy2/gWyrOfIqYB7Drh85lUWLPD QjxpD+LD8j6HkJWtjXojVCyxon74Hd8DUQIO8mmzjNk6sJWmYNhMQnxTmdvvoYpm4RGd +kAClrh/7MkW14l4HtKQtunmnrFuCyy/Y1vKXIB1+AJA3WOsoxaT3iTBzGx3gQGNIqZo 5fXT2O+mvGKUDvdf24x1fF81T1SieTo+7LxN5/fB2OhpvgyGXyq5wpf5lcYWN2s+TUbt 7g== Original-Received: from phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta02.appoci.oracle.com [147.154.114.232]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3mtdmthgp9-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 01 Jan 2023 22:32:00 +0000 Original-Received: from pps.filterd (phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com (8.17.1.5/8.17.1.5) with ESMTP id 301Ln71x005929; Sun, 1 Jan 2023 22:31:59 GMT Original-Received: from nam11-co1-obe.outbound.protection.outlook.com (mail-co1nam11lp2175.outbound.protection.outlook.com [104.47.56.175]) by phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3mtbrabjtn-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 01 Jan 2023 22:31:59 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=JbEeYtQdLYzWQ2ua3PJ/3MYdR15nsT6wfxZaBKpRyRpMdB4kNn7iEABZ4/MlgV3l0wm5c0uE+iiTRVzbw5hKoopcaqmoodGZIT77pG1Qs1B8MCnx2jYpL9ceFtXMrlwV4JNc+xoCC/DPZh4vt9ToqAmrOZq0WOJ/j264gC6n4BLKjlur/X0f6coDlFToVYnFc6RkodDIpla8U8cVTKFjQtRrkgMur+uuUqnDfX1FeqS3PFMXIChNE++Dwr6Mj/iC0f7vvbAETlU1G6Mprbw5C4/8RXVJLkxn4wtE7CtBg/TSJ56mBw740gtlj/9+bqixtKPpURp2TciGXMEeXZVJ+g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3zwAa0t4mPGp6xDuZG1MnKkI6TzWvG49GfuWNraynko=; b=gRHwx/D8lIiQK575aSM59ValaIByzaKu+B5WQGsHGAkjw0ipbsFZWOsLx/xGXQUm5oytUud5zG98zJ0W0SkAFnlEIwrAZVgfyNb3sbEd+w85U184T28iESchLzAYv98VtvUeYuT/h4gLP4ru01TMDy5fTwa16VaOFzIyP9lI0VW1fR/QNvEJYxYIEg39wJdKY1RJo8RJw6yfeDlA6OvKxxrtddcBQk6e65BInB0OhROYXKpM94n6jCEBhMKp2HBhaXXfi01OHNb8DhfXBaUMKqK6kc5rE9IO0sw+Feo57Uwbg2l2mLWebWOzEEvKxO/PwcXEFKFYvSugeuVQssnoQw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oracle.com; dmarc=pass action=none header.from=oracle.com; dkim=pass header.d=oracle.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.onmicrosoft.com; s=selector2-oracle-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=3zwAa0t4mPGp6xDuZG1MnKkI6TzWvG49GfuWNraynko=; b=P12QyfyeF0bhucw00kplr94hN+o6KkhYXezXjXEp0XnDpPUxKuh6qkWs659BxX8qR5SXzKPh1uT6vfbyEvMkKMWUeU3BVZN3YUHFl7eXP23qyVVWSo6BotMRQ0TqSWjHTJ09iNi/CnesIlTyCO9IpSD7wHD/55Gl2Q45gBetGrU= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by DM4PR10MB6280.namprd10.prod.outlook.com (2603:10b6:8:bb::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5944.19; Sun, 1 Jan 2023 22:31:56 +0000 Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::7c3c:e53d:5276:ef29]) by SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::7c3c:e53d:5276:ef29%8]) with mapi id 15.20.5944.019; Sun, 1 Jan 2023 22:31:55 +0000 Thread-Topic: [External] : Re: bug#60470: 26.3; Doc string of `recentf-keep' Thread-Index: Adkd/5vdJfDQDyDrR/qhp4khj7yn4wACgFrnAAj90MA= In-Reply-To: <83pmby2lfd.fsf@gnu.org> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-traffictypediagnostic: SJ0PR10MB5488:EE_|DM4PR10MB6280:EE_ x-ms-office365-filtering-correlation-id: 3c4ea741-0abc-492e-7b53-08daec47fd00 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: uhX6VhcBirJPzf9WqoXaYnrWosA5EeUU8oVCE3WE1Z9Gg+DqrvI8CPID5lcUnW6yylE6cXmqeDdmVBo4PBNP+rVDrryxD9bQ4urHqUpVkCOgg+ML7gzxYUNtE+dPQ0FbOo7y7V3WYK/Vd/JrM0oSD2HJF7jrJNtC+glArfjbRVaHvjKx1ZwYOAXuSIzCu28h8yteYIMiprRieK+M39+ny1b/rZQeSw8WZpxB2j4THfg6bUvoC+wTZSDc1p4dsoWRAnbEv95045IIOTCxu2eqPTGaHogZGYhtEGJludCzlwM5tmXcw7ECLxiQSKOBiHHQ2PBNcACKCP2xcM7RqHre4sY6mn4RMaYkYewjfXr26o1Kg6HwTY8Pilng2JUCXDhskJZDIuXXfgaodlv8lqU+mEx4gvrts6zpsGcF+6J57xi6HOWFb1LY4i5VFwpVIJWQtmUpGUM+bSJI8H7QPa8pSaa2C+cEycLO+077+QFW2rvjbWhQZj9SqpuNPuKjyqqDq91VSJ8RzgR+NGcPEaAaGQRKAcFRd8breDgDP75s7qye0Adw2B8LhexfjeJC7SWpuN8V3pclnCv62kt8h1S3VQ22U0ZEbKtRMbY33zqlNk9a1q7iaRQSdm+qjW2wpQfy4Lo94azHMpeNbfUmPIb/fl9mMd7uFLj0F31q6/F3SCB8ijZ7vkuznF+F2wYfUwUkxFZbquGXhC3ntbuXmJr61x2p4WQC+weMuw27u16Pt1IMWwqPmjzSS6ZbJ0VwJ Tt5 x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR10MB5488.namprd10.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230022)(136003)(39860400002)(366004)(376002)(346002)(396003)(451199015)(41300700001)(76116006)(8676002)(8936002)(5660300002)(64756008)(4326008)(66556008)(66446008)(66946007)(66476007)(6916009)(2906002)(44832011)(52536014)(316002)(6506007)(71200400001)(7696005)(478600001)(9686003)(186003)(26005)(86362001)(55016003)(83380400001)(122000001)(38100700002)(38070700005)(33656002)(22166006)(81973001); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: LxNVR3gp+EoFywWRJzucUuVOyX2TKRiw2hdIdbKYS7n6wtWZiGC+CKGPhc6mRTPlhXKGKdCR8njBFiIR/ZW4vLRZnFQfdQOYVYYrX/DcsK/8Xdxz4sYWE2jpxDi7Db3XBsjFNSj7UL9wZUHRhdERUlo79Fqy8Ls7TowmR1FhrfGYiLUKNqkSCXFV9arcNidX+KyArdM0RU2F1uLS7/80lHxZAJsBsfBD1V3xgPtJJH9hNgWioOsX+ExqFnyhBuZulauXiNJc/QlNJSug75w7f+YXBkNlh+rYMLQVy2/vpQMD+J5GSKhbgdXNXZFEuveH/+pnddg9zTgLOCSMMqL6OMb8BFFnQXr2nBi7XjYQr7I65zjtVpypSJAPcN4OYJ/XHOB2F93HvrKNSAGdMgRxxOluHjuKGrmZQ6770c4RvoqaaM4FubKvsq1sHwPZqHI7P6g+BQWWRk4617rBFK6HOvQKYHQCboIvgkgoc0DhLt6jSOaEiYMradTE/8teqR6IjzYYkNkgV48fUio5dsDvB3gK4qTcHGqzcwtt9ULFg15xPwglSw7A2qvEPb5T9IBL2BB4bbAmei3SFpZAKS+gyvRwOsohy5E12SUZmy/jxZySRLGSaNIvZPlLcbOybYEbFOqVoCM9tYBmBz0zfyxljVHy9OYVshR2ThtuhdPZx0QSrcVrXejI22vSXFoZVFg3ebziY1ky7Z1HMq32rCVVkYpMqcsf3x8iBHCDaHuW1ZWkXTB42WDQau4WbT VUuNSa8Wx78Q0jW0F8X9f9XQNTBzNC/scFqBkVyc8paDINQf8lhnroixkLMSpfG6ASbxQjMgTC7Z/WTi+/Ds5xo/dObc1mcU7K X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SJ0PR10MB5488.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 3c4ea741-0abc-492e-7b53-08daec47fd00 X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Jan 2023 22:31:55.7534 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: aZtJuFZLKr8UkbvKeUA1tr0RO+paru+KfmQQpmBmvG0n72si3hqWz/Z593ckkCIHuDTMhfz19Z7o9bqmS8sX3w== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR10MB6280 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.923,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2023-01-01_11,2022-12-30_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 bulkscore=0 mlxscore=0 malwarescore=0 mlxlogscore=878 phishscore=0 spamscore=0 suspectscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2301010208 X-Proofpoint-GUID: -ZETF0y2AdmMdY3KbhK7Q-SSy7_XUlom X-Proofpoint-ORIG-GUID: -ZETF0y2AdmMdY3KbhK7Q-SSy7_XUlom 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:252292 Archived-At: > > Please consider saying in the doc string what it=20 > > means to "keep" a file name in the recent list. > > > > The doc string goes into what it means to be a > > predicate, but it says nothing, really, about > > what this option means/does, because it tells > > you nothing about what "keeping" amounts to. >=20 > 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. >=20 > So I'm closing this bug. FWIW, I don't see any such explanation, in any doc string. Following the code - e.g. the places where `recentf-keep-p' is used, I can see that the use of `recentf-keep' differs from the use of `recentf-exclude' (besides filtering in instead of out) in that `recentf-keep' filtering happens when you kill a buffer (via `recentf-track-closed-file') or whether "cleanup" occurs. That info is missing from the option doc string. 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? I think a user will wonder about this. And in particular I don't see anything in the doc string of `recentf-keep' that speaks to it - nothing that makes you not wonder how this differs from the use of option `recentf-exclude' (besides filtering in the opposite sense). 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? You can figure it out by either (1) looking at the code or (2) checking _all_ of the doc to get a list of the possible removal events/operations/occurrences, and surmising that `recentf-keep' takes effect for all of them. But I don't see how you can figure it out just by looking at the `recentf-keep' doc string. Would you mind pointing to the part of the doc string that you think explains what "keeping" means? I really don't see it.