From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stephen Berman Newsgroups: gmane.emacs.bugs Subject: bug#13801: [PATCH] Trivial fix for files.el Date: Sun, 24 Feb 2013 22:45:41 +0100 Message-ID: <87wqtx5qt6.fsf@rosalinde.fritz.box> References: <20130224143332.f33f9e158da879bd206e83cc@gmail.com> <83mwutkayo.fsf@gnu.org> <6EA8FD3B20FB44C289A386DEA3E477D9@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1361742513 17303 80.91.229.3 (24 Feb 2013 21:48:33 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 24 Feb 2013 21:48:33 +0000 (UTC) Cc: 'Xue Fuqiao' , 13801@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Feb 24 22:48:55 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 1U9jRH-0001N3-EQ for geb-bug-gnu-emacs@m.gmane.org; Sun, 24 Feb 2013 22:48:55 +0100 Original-Received: from localhost ([::1]:52307 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U9jQw-0006nB-Tp for geb-bug-gnu-emacs@m.gmane.org; Sun, 24 Feb 2013 16:48:34 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:51193) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U9jQr-0006ms-HF for bug-gnu-emacs@gnu.org; Sun, 24 Feb 2013 16:48:32 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1U9jQo-0001aZ-MK for bug-gnu-emacs@gnu.org; Sun, 24 Feb 2013 16:48:29 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:42682) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U9jQo-0001aN-IU for bug-gnu-emacs@gnu.org; Sun, 24 Feb 2013 16:48:26 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1U9jSL-0007sa-Om for bug-gnu-emacs@gnu.org; Sun, 24 Feb 2013 16:50:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stephen Berman Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 24 Feb 2013 21:50:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13801 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 13801-submit@debbugs.gnu.org id=B13801.136174257630250 (code B ref 13801); Sun, 24 Feb 2013 21:50:01 +0000 Original-Received: (at 13801) by debbugs.gnu.org; 24 Feb 2013 21:49:36 +0000 Original-Received: from localhost ([127.0.0.1]:48145 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1U9jRv-0007rq-Tn for submit@debbugs.gnu.org; Sun, 24 Feb 2013 16:49:36 -0500 Original-Received: from mout.gmx.net ([212.227.15.18]:56859) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1U9jRr-0007rh-I5 for 13801@debbugs.gnu.org; Sun, 24 Feb 2013 16:49:33 -0500 Original-Received: from mailout-de.gmx.net ([10.1.76.32]) by mrigmx.server.lan (mrigmx001) with ESMTP (Nemesis) id 0MPb5D-1UEQMA2mUT-004h2P for <13801@debbugs.gnu.org>; Sun, 24 Feb 2013 22:45:43 +0100 Original-Received: (qmail invoked by alias); 24 Feb 2013 21:45:43 -0000 Original-Received: from i59F550B9.versanet.de (EHLO rosalinde.fritz.box) [89.245.80.185] by mail.gmx.net (mp032) with SMTP; 24 Feb 2013 22:45:43 +0100 X-Authenticated: #20778731 X-Provags-ID: V01U2FsdGVkX1/fEF9Z0uLfLMDcASNmomD1rdZkNCLacjY27mCvh2 2NRvik5GIAwWY3 In-Reply-To: <6EA8FD3B20FB44C289A386DEA3E477D9@us.oracle.com> (Drew Adams's message of "Sun, 24 Feb 2013 09:47:44 -0800") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) X-Y-GMX-Trusted: 0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.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:71753 Archived-At: On Sun, 24 Feb 2013 09:47:44 -0800 "Drew Adams" wrote: >> The first line of the doc string should concisely say what >> the option does. > > Correct. > > Including, if possible, what a nil or non-nil value does, if the option is > Boolean. And the first line should (must) be a full sentence. > >> The old doc string did it, albeit not perfectly; > > Incorrect. The first line did not do that at all. At all. > >> the one you suggest does not. > > Correct. My guess is that it was an attempt to provide a short full sentence > (good), but it does not say what the option does (not good). > > What is important in both the old and new doc strings, and can serve as the > first line, is that the option does this (77 chars): > > "Non-nil means break a hard link for the visited file and write to a new file." To keep it under 68 characters (as per (elisp) Documentation Tips), how about: Non-nil means write visited file to a new file, breaking hard links. Steve Berman