From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Chong Yidong Newsgroups: gmane.emacs.bugs Subject: bug#3888: Some variables get the wrong, platform-specific, documentation Date: Mon, 20 Jul 2009 16:25:38 -0400 Message-ID: <87ws63gkzh.fsf@stupidchicken.com> Reply-To: Chong Yidong , 3888@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1248124677 10406 80.91.229.12 (20 Jul 2009 21:17:57 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 20 Jul 2009 21:17:57 +0000 (UTC) Cc: 3888@emacsbugs.donarmstrong.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jul 20 23:17:50 2009 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1MT0F2-0002zO-9f for geb-bug-gnu-emacs@m.gmane.org; Mon, 20 Jul 2009 23:17:48 +0200 Original-Received: from localhost ([127.0.0.1]:52051 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MT0F1-0005Gv-J0 for geb-bug-gnu-emacs@m.gmane.org; Mon, 20 Jul 2009 17:17:47 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MT0Ep-00054x-Lr for bug-gnu-emacs@gnu.org; Mon, 20 Jul 2009 17:17:35 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MT0El-0004vr-Sp for bug-gnu-emacs@gnu.org; Mon, 20 Jul 2009 17:17:35 -0400 Original-Received: from [199.232.76.173] (port=57721 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MT0El-0004v5-HS for bug-gnu-emacs@gnu.org; Mon, 20 Jul 2009 17:17:31 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:52845) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MT0El-0002Xc-3t for bug-gnu-emacs@gnu.org; Mon, 20 Jul 2009 17:17:31 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n6KLHTFK023657; Mon, 20 Jul 2009 14:17:29 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.14.3/8.14.3/Submit) id n6KLF5d6023006; Mon, 20 Jul 2009 14:15:05 -0700 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: Chong Yidong Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Mon, 20 Jul 2009 21:15:05 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: followup 3888 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Original-Received: via spool by 3888-submit@emacsbugs.donarmstrong.com id=B3888.124812425322467 (code B ref 3888); Mon, 20 Jul 2009 21:15:05 +0000 Original-Received: (at 3888) by emacsbugs.donarmstrong.com; 20 Jul 2009 21:10:53 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from pantheon-po38.its.yale.edu (pantheon-po38.its.yale.edu [130.132.50.97]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n6KLAnba022462 for <3888@emacsbugs.donarmstrong.com>; Mon, 20 Jul 2009 14:10:50 -0700 Original-Received: from furry (dhcp128036014244.central.yale.edu [128.36.14.244]) (authenticated bits=0) by pantheon-po38.its.yale.edu (8.12.11.20060308/8.12.11) with ESMTP id n6KLAh5w009462 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Mon, 20 Jul 2009 17:10:43 -0400 Original-Received: by furry (Postfix, from userid 1000) id BD503C056; Mon, 20 Jul 2009 16:25:38 -0400 (EDT) X-YaleITSMailFilter: Version 1.2c (attachment(s) not renamed) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 2) Resent-Date: Mon, 20 Jul 2009 17:17:35 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:29527 Archived-At: > > I guess this is because term/pc-win.elc is now in SOME_MACHINE_LISP in > > src/Makefile.in. (It was not there in Emacs 22.) > > None of the *-win.elc files was in SOME_MACHINE_LISP in Emacs 22, > which is why documentation of several important functions and > variables were not in etc/DOC. But there were other platform-specific > files in SOME_MACHINE_LISP: dos-fns.elc, w32-fns.elc, vmsproc.elc, > etc. So the problem is not new. > > I think this calls for some infrastructure that is currently missing: > how to define a platform-specific implementation of an API without > clobbering the doc string for other platforms. Maybe some markup in > the doc string that would allow to have platform-specific parts there? I think, as a temporary solution, we should make the docstrings of all the affected functions and variables the same. If necessary, they can say somehthing like, "On Windows, this does X. On Nexstep, this does Y", and so on.