From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#15159: 24.3.50; doc of `file-relative-name' Date: Thu, 22 Aug 2013 08:34:57 -0700 (PDT) Message-ID: <99276c69-bc4a-4406-b6c2-921c38dba82e@default> References: <<88607a9f-9b87-45b3-b661-99970acc0c97@default>> <<83d2p5kcps.fsf@gnu.org>> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1377185789 9296 80.91.229.3 (22 Aug 2013 15:36:29 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 22 Aug 2013 15:36:29 +0000 (UTC) Cc: 15159@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Aug 22 17:36:29 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VCWvx-0003Lf-Hd for geb-bug-gnu-emacs@m.gmane.org; Thu, 22 Aug 2013 17:36:25 +0200 Original-Received: from localhost ([::1]:60460 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VCWvx-0006eQ-5x for geb-bug-gnu-emacs@m.gmane.org; Thu, 22 Aug 2013 11:36:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40515) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VCWvk-0006Ro-Kp for bug-gnu-emacs@gnu.org; Thu, 22 Aug 2013 11:36:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VCWvc-0005mB-3w for bug-gnu-emacs@gnu.org; Thu, 22 Aug 2013 11:36:12 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:53583) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VCWva-0005lq-OJ for bug-gnu-emacs@gnu.org; Thu, 22 Aug 2013 11:36:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1VCWva-00022V-82 for bug-gnu-emacs@gnu.org; Thu, 22 Aug 2013 11:36:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 22 Aug 2013 15:36:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 15159 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 15159-submit@debbugs.gnu.org id=B15159.13771857037760 (code B ref 15159); Thu, 22 Aug 2013 15:36:02 +0000 Original-Received: (at 15159) by debbugs.gnu.org; 22 Aug 2013 15:35:03 +0000 Original-Received: from localhost ([127.0.0.1]:47899 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VCWud-000215-Ga for submit@debbugs.gnu.org; Thu, 22 Aug 2013 11:35:03 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:35498) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VCWuc-00020h-63 for 15159@debbugs.gnu.org; Thu, 22 Aug 2013 11:35:02 -0400 Original-Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r7MFYxcT003124 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 22 Aug 2013 15:35:01 GMT Original-Received: from aserz7021.oracle.com (aserz7021.oracle.com [141.146.126.230]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r7MFYvYp008723 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Thu, 22 Aug 2013 15:34:58 GMT Original-Received: from abhmt113.oracle.com (abhmt113.oracle.com [141.146.116.65]) by aserz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r7MFYvvr012125; Thu, 22 Aug 2013 15:34:57 GMT In-Reply-To: <<83d2p5kcps.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:77610 Archived-At: > > The doc says nothing about whether arg FILENAME needs to be absolute or > > relative, and in fact it can be either. It is clear enough what the > > function does if it is absolute, but the doc should say explicitly what > > it does for a relative FILENAME, namely, it expands the FILENAME in the > > `default-directory' of the current buffer. >=20 > Sorry, but I see nothing unclear in this doc string: >=20 > (file-relative-name FILENAME &optional DIRECTORY) >=20 > Convert FILENAME to be relative to DIRECTORY (default: `default- > directory'). > This function returns a relative file name which is equivalent to FILEN= AME > when used with that default directory as the default. >=20 > "Convert FILENAME to be relative to DIRECTORY" is accurate and > unequivocal. The fact that relative file names are treated as > relative to the current buffer's default-directory is what Emacs does > with _every_ file name in _any_ function; if users don't know this > basic fact, they will have problems all over the place. OK, so everything is clear to you. Wunderbar. I reported this bug because everything was not clear to me. To begin with, it was not clear to me whether FILENAME needed to be absolute. OK, so I tried it and figured out how the function handles a relative FILENAME. Not a big deal. Still, I would suggest (again) that the doc=20 make this clear by being explicit.