From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: Tramp docstring Date: Mon, 12 Jul 2004 13:40:01 -0500 (CDT) Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <200407121840.i6CIe1J27856@raven.dms.auburn.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1089657809 21172 80.91.224.253 (12 Jul 2004 18:43:29 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 12 Jul 2004 18:43:29 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Mon Jul 12 20:43:15 2004 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1Bk5lj-0001Nb-00 for ; Mon, 12 Jul 2004 20:43:15 +0200 Original-Received: from lists.gnu.org ([199.232.76.165]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1Bk5li-0000J7-00 for ; Mon, 12 Jul 2004 20:43:14 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1Bk5o3-000606-AI for emacs-devel@quimby.gnus.org; Mon, 12 Jul 2004 14:45:39 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1Bk5o1-000601-Jm for emacs-devel@gnu.org; Mon, 12 Jul 2004 14:45:37 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1Bk5o0-0005zp-48 for emacs-devel@gnu.org; Mon, 12 Jul 2004 14:45:37 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1Bk5o0-0005zm-1z for emacs-devel@gnu.org; Mon, 12 Jul 2004 14:45:36 -0400 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.34) id 1Bk5lB-00087q-N2 for emacs-devel@gnu.org; Mon, 12 Jul 2004 14:42:41 -0400 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id i6CIgduE018243; Mon, 12 Jul 2004 13:42:40 -0500 (CDT) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.6+Sun/8.11.6) id i6CIe1J27856; Mon, 12 Jul 2004 13:40:01 -0500 (CDT) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: kai@emptydomain.de X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:25626 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:25626 As I said before, `verify-visited-file-modtime' itself takes care of the cases where `visited-file-modtime' returns 0 or the buffer is not visiting a file, so `tramp-handle-verify-visited-file-modtime' does not need to. However, this means that `tramp-handle-verify-visited-file-modtime' can not be called directly, unless the caller first takes care of those two cases. That probably is no problem, but these facts should be at least pointed out as a comment. To be sure that people are not tempted to call the function directly after doing C-h f, I prefer to put it in the docstring. But a comment would be OK too. What about the following new docstring? "Like `verify-visited-file-modtime' for tramp files. At the time this function is called, we already know that the buffer is visiting a file and that `visited-file-modtime' does not return 0. Do not call this function directly, unless those two cases are already taken care of." Sincerely, Luc.