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#54191: [External] : Re: bug#54191: 26.3; (elisp) `Magic File Names' FILENAME parameters: absolute names? Date: Mon, 28 Feb 2022 16:26:00 +0000 Message-ID: References: <87tucja05k.fsf@gmx.de> 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="35579"; mail-complaints-to="usenet@ciao.gmane.io" Cc: "54191@debbugs.gnu.org" <54191@debbugs.gnu.org> To: Michael Albinus Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Feb 28 17:27:23 2022 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 1nOirq-00094T-9T for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 28 Feb 2022 17:27:22 +0100 Original-Received: from localhost ([::1]:33656 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nOiro-0003i4-OW for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 28 Feb 2022 11:27:20 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:50952) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nOirW-0003gh-Va for bug-gnu-emacs@gnu.org; Mon, 28 Feb 2022 11:27:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40716) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nOirW-0002a7-NB for bug-gnu-emacs@gnu.org; Mon, 28 Feb 2022 11:27:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nOirW-0004VH-HB for bug-gnu-emacs@gnu.org; Mon, 28 Feb 2022 11:27: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: Mon, 28 Feb 2022 16:27:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 54191 X-GNU-PR-Package: emacs Original-Received: via spool by 54191-submit@debbugs.gnu.org id=B54191.164606557017223 (code B ref 54191); Mon, 28 Feb 2022 16:27:02 +0000 Original-Received: (at 54191) by debbugs.gnu.org; 28 Feb 2022 16:26:10 +0000 Original-Received: from localhost ([127.0.0.1]:34605 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nOiqg-0004Tj-3C for submit@debbugs.gnu.org; Mon, 28 Feb 2022 11:26:10 -0500 Original-Received: from mx0a-00069f02.pphosted.com ([205.220.165.32]:38614) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nOiqe-0004Tb-LJ for 54191@debbugs.gnu.org; Mon, 28 Feb 2022 11:26:09 -0500 Original-Received: from pps.filterd (m0246629.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.16.1.2/8.16.1.2) with SMTP id 21SFY3lq008475; Mon, 28 Feb 2022 16:26:07 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-2021-07-09; bh=BrR3BUmtJS2RWyc49ahKXi1cy9WeQ2XZXZNX82mcGGI=; b=ngpZKhoABJJzSwgN/jvmmni7zZPizQj6CEoArtKLgzeM3xczMd+Qi3C8YBPjJ7FJrFrW fv6zQZ0H2FnRF3lU0fWd9iCZm+/1Yu+Pch8A+WNdQ/HQ52Z628AGFVHjz3/Oo+XVXqVV k3hEmE9clAkRM5CZKnZjJik00CgtixZkBeaVqGIOSSQZgjrBUQTugsIUgQhDXm76hsjJ 4HkF0WbH5DFjIoEsZdw1J3prJkuEMXrR6zQPgD6HpnNDyfFbuTNUlsyE3ycMCIA/cY9x wNY5kbMKryT7OXKZBGhER58wODAB63wSnXIIbhh/nE4Q1jxLPWhBRX84lKKII5nCVEjY UQ== Original-Received: from aserp3020.oracle.com (aserp3020.oracle.com [141.146.126.70]) by mx0b-00069f02.pphosted.com with ESMTP id 3eh15ag5yf-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 28 Feb 2022 16:26:06 +0000 Original-Received: from pps.filterd (aserp3020.oracle.com [127.0.0.1]) by aserp3020.oracle.com (8.16.1.2/8.16.1.2) with SMTP id 21SG6jg0160545; Mon, 28 Feb 2022 16:26:03 GMT Original-Received: from nam10-mw2-obe.outbound.protection.outlook.com (mail-mw2nam10lp2105.outbound.protection.outlook.com [104.47.55.105]) by aserp3020.oracle.com with ESMTP id 3efc1370fx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 28 Feb 2022 16:26:03 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=WRuQ0VMROxrzudQnuxs4EmwmeLwgT8N0j1mOvMpNMTVsOVeyncxV5BXS1Cjr2U+vyaqbQCaSMON7UzAzHLIL3Y8z5S15myo41ux4j/Fo5k/XrBX1HsFOAEBU106K+dbur6g55EeIONdONyZMri6fQyc9BJXcGtmPcePgwXO8j0eRCu7ryyF49WrUB5m/FdIQNxAn3i/+RgNu0eSSOAZgdceWceEoi/3A76CDN0AZAE84KiOV69dvPiTPPTbWJWQrD3ZcW7WfkFSGRMf5omSiqLTQY5R529iBh5lJxE92/ERjQrfqowQ1rxcgusPeFM/I7rrivt/m3fqaXMfGeV7SXA== 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=BrR3BUmtJS2RWyc49ahKXi1cy9WeQ2XZXZNX82mcGGI=; b=OL6l7Pq7PsiSch4Ow+Q+tp2NyJyqhry6wTpugZLpmsYzya/iYrCel+tIQ+cEf53ML9PbJpCSDHXt5mq3KiG6AOth7G5XMHAwxA9GYE6aNX0yJXG7a1aD1NsQpGSj2ozEFeqjdujxGkeudbptanf261HCc07imRTzo3W8lH4cd1GA4bXVtXLUS8FE4q2EJkKK8VVG+y68VcfIWqmsh0MMvl4YIna+7G99hiZNlQ922ngdzyEdZQMT+C21VBh7+VXZqXV7TR3T1SXu5TtmCYhueQT8aaj6E0eSGQ9GKFvJYtKr03K1on3BbmimU73vn+LFbC4eqhYOHdZMTOLSUSrPaw== 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=BrR3BUmtJS2RWyc49ahKXi1cy9WeQ2XZXZNX82mcGGI=; b=D5GAFzpVWZHh03ZzcBDt8cT6qZVshD0yvi3TskSXklpP6Vu5aG/neGdmsZjE0QFRV6iDvgmbVVOh9QUppVYUpPBnbF/CeCPkupH0HoGHAc38a2odkLpOIrC1/g6PeyBguXWc0EqDyOk80NaMWPvfYde9MiAEUCnIbOACgVqteNE= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by MN2PR10MB3758.namprd10.prod.outlook.com (2603:10b6:208:1b9::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5017.24; Mon, 28 Feb 2022 16:26:00 +0000 Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::f811:66c9:41ab:df79]) by SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::f811:66c9:41ab:df79%7]) with mapi id 15.20.5017.027; Mon, 28 Feb 2022 16:26:00 +0000 Thread-Topic: [External] : Re: bug#54191: 26.3; (elisp) `Magic File Names' FILENAME parameters: absolute names? Thread-Index: AdgsHz6P6idnU1/7S0us9A5/FzzySQAWmMn+ABB4XJA= In-Reply-To: <87tucja05k.fsf@gmx.de> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: ded4c2bc-9651-4dee-3eec-08d9fad701ce x-ms-traffictypediagnostic: MN2PR10MB3758:EE_ x-microsoft-antispam-prvs: x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: qTFsCsNF/Q/+nsCUjc85tZsp198dutRu0xThdScma85zEILmc7BkjiCDJcWaKxQXwQIZGgVp8bpw/3zwxKCdS7DetyvQGJo5zEcYVjVcjI97en11tsyHxXy7uyiJw/g1pU72O9C2EvH/+aCQiGj+OrSyp5OC+iM2PjAIOTDcG+DRvi081W44wIyhw+EVoHlqXtZs9aHeUhjRfDkB8f1hKHSOz6ypiV7n1fLeMIak7bMjDFk/sjCYaApfevlTNnV+DyLn/7mT/t6xgC2qWoxOG80TYmfk3XXb0H3KySLFlGSWG8FEsc+2TLq029O3CNBD6qdOn/D2Y7Ns2vTYJecrMWi+5AuqTQhvCbK6kqXs8CsviqhmOsgma6tvYt50FeTsrqpRasBn1fvh9piu1KEn33JC6O/2sCTD+S6I3cfBEoLmVxhC8O4E/zk/rP38FAsHY1apIRua4eFG964AbtIg1FwsviA5ziDXYAaq5BDg5JC9OMmwDtqtXVBRmQLdC9eWQccRdQ3s1sUQ8z5or8OVc0eGUwfpTks1unPt65BpifQo9r0bubjbBC14URfGV6UNHka9fhhnxIy3VLlryVc4VNG89DU+5YtIFauNKvUwC4TobLDGM4ggIq7ilniPoS3OTV+JrVQf9Uk4Doc2QHNeBUnZIf32rz2FSSX0P9cIb2zLYRlx0C/jvAOXIZ0trSGBw+kHO/s71PIEkFKNEHzoA6Qwg3q4Hy8DIrc9cF8UBtU= 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:(13230001)(366004)(55016003)(52536014)(86362001)(66446008)(8676002)(64756008)(33656002)(4326008)(186003)(26005)(66556008)(66476007)(66946007)(76116006)(38100700002)(83380400001)(6506007)(316002)(9686003)(122000001)(7696005)(44832011)(508600001)(8936002)(71200400001)(38070700005)(6916009)(5660300002)(2906002)(81973001); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: Z3+n+U/LhVA6lpiyaK4EQLmBU58i7foV9hPILuuHdGAFt5bL2+Nk801p1VxtPmtGxUr4OU1svDLSNVVirYj/WTKTuK4GRO+/007J1oK5br0kooDsDVnd7nTNwPKW9lhOocFRNSm/vVZ21yu1Ujis+EeK0e57omIgEmSTScJdfsJzzOmvrJv+GtO/xyb0qOsd31jl8m6DFoG4hh6+LyORnTq5vMyPvcv658zOf2DruZLPCt2BDzEldAD1SojBVF4PXeIN4NgVJcSUsmgIPvWV8a2BXapx6HTS9Un3jwUGSKhYEyyn1LhJ8ukPAmaaIc0I5zAqDP0t4dqrJ5FLsyjVJzTrHKWijyY+eSoBaIivFck7DPYWrxCbDbtqmF6OgJZcv/Ks359q/0uF0I1vVcgxGvl1hbV22ZI1Olp1XYhaJlhrb6Jeh8dsrB9IhIz0P2ktjzVeWmR1U+BUZOOVh0eWiy/rG47LPd9pY2B6QWmNXSeN38L3ehUVctIuCYcGjRByOA31WFQ/YroN1cANclKQrNkOwRIe7zFoMy2J0Md8OXq85ioCwi4+4Vsnhw+DFERfeiDhDq2dpyxEBakrDx+GzAe37jdUqFhroA/ixCLntHXzhfjPnjZeOknZlecSQtmhDtjyLqS4diLl7uqIpGkGik4y01SyNj5XfG/1Uxc1oPbcCorbhtWbxw/Z8msLZmHSiNdWGM7Er1NB8reKy3nqcqozfSW/5l1zkZcoJjXLylSV1VaDdx5zuGRl/x iZhiRwqhVDr4JMmK1g1QE0kCpJKE9RaArGxljpr58xWDVOW1jLo2XfTtog4drBSJUugkiTpoT++ktoEpv6ZclN5HVIqoIyscql 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: ded4c2bc-9651-4dee-3eec-08d9fad701ce X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Feb 2022 16:26:00.3748 (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: P23SwsL8g/0YXadzeCcqYZr9wf6LFeSWAmA6nVdprVMYcJ9aM37GqQRp0UdhsQ4ct2HK1tBulq0esckvMzgYwQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR10MB3758 X-Proofpoint-Virus-Version: vendor=nai engine=6300 definitions=10272 signatures=684655 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 mlxscore=0 phishscore=0 bulkscore=0 adultscore=0 spamscore=0 suspectscore=0 mlxlogscore=999 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2201110000 definitions=main-2202280086 X-Proofpoint-ORIG-GUID: qHB_audPv6tBPO09OPDE4QP_QuddNyg_ X-Proofpoint-GUID: qHB_audPv6tBPO09OPDE4QP_QuddNyg_ 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" Xref: news.gmane.io gmane.emacs.bugs:227832 Archived-At: > > OK, I see that the doc string of `file-remote-p' - > > but NOT its description in the Elisp manual - does > > at least call out what happens if the arg FILE is > > a relative file name: the function just returns nil. > > > > That doesn't invalidate the rest of what this bug > > report says. Each function's description should say > > what kind of file-name argument it expects, and if > > it handles both relative and absolute file names, > > how it does so - how it treats each kind. >=20 > We could discuss forever, whether this information is needed in the > Elisp manual. In my understanding, the manual is not an "extended > docstring". It is rather meant to give another view, with the help of > examples etc. IIRC, it isn't said anywhere, that a manual entry must be > comprehensive w/o the docstring. I don't disagree that the manual need not say the same things as a doc string. Sometimes it should say more, sometimes less, sometimes something different (but not contradictory). The "rest of what this bug report says" is not that the manual is missing something the doc strings say. Neither the manual nor the doc strings (except `file-remote-p', at least) state that the file name is expected to be absolute - or more precisely say what the behavior is for absolute vs relative. But that info is important for using the functions, IMO. All I was saying there was that (1) the doc string of `file-remote-p' does in fact say what happens differently for a relative file name - which is good, helpful, and (2) I noticed this happy exception after filing the general report that the doc (strings & manual) generally does NOT mention what kind of file name is expected, for functions that accept a file name. That general lack is the reported bug. That there are happy exceptions doesn't mean there aren't places where the doc (strings or manual or both) can be clarified to specify this. > > Users shouldn't have to search the Elisp code base > > to try to figure out whether they might need to > > apply `expand-file-name' to a file name before > > passing it to some function. >=20 > There's no need to read the implementation. The docstring of > file-remote-p is clear about this point. We agree, and that's exactly what I said in the mail you replied to. And thank you to whoever included that info in that particular doc string.