From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: martin rudalics Newsgroups: gmane.emacs.bugs Subject: bug#12158: 24.1; unclear, incomplete doc of window parameter `quit-restore' Date: Thu, 09 Aug 2012 20:01:34 +0200 Message-ID: <5023FAFE.1030006@gmx.at> References: <50237869.5000004@gmx.at> <7F77380D0CBD41C0AC4452F9BACC9709@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1344535321 28459 80.91.229.3 (9 Aug 2012 18:02:01 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 9 Aug 2012 18:02:01 +0000 (UTC) Cc: 12158@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Aug 09 20:01:57 2012 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 1SzX3V-0005Ss-0R for geb-bug-gnu-emacs@m.gmane.org; Thu, 09 Aug 2012 20:01:57 +0200 Original-Received: from localhost ([::1]:59076 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzX3U-0003cg-A4 for geb-bug-gnu-emacs@m.gmane.org; Thu, 09 Aug 2012 14:01:56 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:47711) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzX3R-0003cZ-30 for bug-gnu-emacs@gnu.org; Thu, 09 Aug 2012 14:01:54 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SzX3P-0001GP-In for bug-gnu-emacs@gnu.org; Thu, 09 Aug 2012 14:01:52 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:35472) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzX3P-0001GE-FH for bug-gnu-emacs@gnu.org; Thu, 09 Aug 2012 14:01:51 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1SzXBJ-00009v-Qp for bug-gnu-emacs@gnu.org; Thu, 09 Aug 2012 14:10:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: martin rudalics Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 09 Aug 2012 18:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 12158 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 12158-submit@debbugs.gnu.org id=B12158.1344535796596 (code B ref 12158); Thu, 09 Aug 2012 18:10:01 +0000 Original-Received: (at 12158) by debbugs.gnu.org; 9 Aug 2012 18:09:56 +0000 Original-Received: from localhost ([127.0.0.1]:45018 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1SzXBD-00009Z-NB for submit@debbugs.gnu.org; Thu, 09 Aug 2012 14:09:56 -0400 Original-Received: from mailout-de.gmx.net ([213.165.64.23]:33810) by debbugs.gnu.org with smtp (Exim 4.72) (envelope-from ) id 1SzXBB-00009R-7N for 12158@debbugs.gnu.org; Thu, 09 Aug 2012 14:09:54 -0400 Original-Received: (qmail invoked by alias); 09 Aug 2012 18:01:41 -0000 Original-Received: from 62-47-46-101.adsl.highway.telekom.at (EHLO [62.47.46.101]) [62.47.46.101] by mail.gmx.net (mp037) with SMTP; 09 Aug 2012 20:01:41 +0200 X-Authenticated: #14592706 X-Provags-ID: V01U2FsdGVkX189JrsKaE49zkrkb4o0SEEoFZRXtOHokd4RkdBO/S vMF7VHeXWMXu+f In-Reply-To: <7F77380D0CBD41C0AC4452F9BACC9709@us.oracle.com> 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 (newer, 2) 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:62974 Archived-At: >> The value of the `quit-restore' parameter is set by the buffer display >> routines and inspected when quitting the window. Applications are not >> supposed to inspect or alter the value of this parameter. > > If this is supposed to be internal, then do not doc it. If not, please doc it > so readers can understand. The value of the parameter is supposed to be internal. > I only came to this doc because you pointed me to it explicitly, when trying to > investigate a (user) bug. So it's not super clear (to me) just how internal > this topic should be. I pointed you to it because you apparently were not aware of the existence of window parameters and looked for frame parameters instead. >> The window-pub branch contains a detailed description of an earlier >> version of this parameter. You can find it here: >> http://bzr.savannah.gnu.org/lh/emacs/old-branches/window-pub/a > nnotate/head:/doc/lispref/windows.texi > > The existence of that description outside of Emacs does not help users much. It can help anyone interested understand whether describing the parameter in the manual would help users at all. >> In the course of subsequent changes to the buffer display code, this >> description was omitted from the current version of the manual. > > I guess you are saying that that omission was a mistake. Your guess is wrong. > Please include the > missing info, then. AFAICT that information is of no practical value for users. OTOH informing users that a parameter with that name exists _is_ of practical value to avoid that they implement a parameter with the same name. And it is of practical value for users to know who creates that parameter and who uses it. Otherwise users might think that _they_ are supposed to change or check that parameter. If people think that the information I gave is not needed, I have no problems removing it from the manual. >> These parameters are listed in this node in order to tell programmers >> that their names are in use and which parts of the Emacs code use it. >> If any information is missing, please provide a report. > > It is not up to me to determine all that might be missing - I have no idea. The > explanation should be be complete and understandable; that's all. IMHO the present explantion is complete and understandable. Programmers who do need more information will find it in the doc-string of `display-buffer-record-window'. martin