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#21225: 25.0.50; doc strings of `define-obsolete-*' Date: Sun, 9 Aug 2015 10:28:50 -0700 (PDT) Message-ID: <7ec85eda-d5e0-4bda-8dba-4a75fe5f93e5@default> 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 1439141428 26533 80.91.229.3 (9 Aug 2015 17:30:28 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 9 Aug 2015 17:30:28 +0000 (UTC) To: 21225@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Aug 09 19:30:15 2015 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 1ZOUQI-0008Ad-IP for geb-bug-gnu-emacs@m.gmane.org; Sun, 09 Aug 2015 19:30:14 +0200 Original-Received: from localhost ([::1]:55842 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUQH-000057-Pg for geb-bug-gnu-emacs@m.gmane.org; Sun, 09 Aug 2015 13:30:13 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51267) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUQD-0008WV-OJ for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:30:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZOUQ9-0000rj-Sn for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:30:09 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:59185) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUQ9-0000pT-Lz for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:30:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1ZOUQ8-0001Mz-7B for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:30:04 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 09 Aug 2015 17:30:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 21225 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.14391413585190 (code B ref -1); Sun, 09 Aug 2015 17:30:03 +0000 Original-Received: (at submit) by debbugs.gnu.org; 9 Aug 2015 17:29:18 +0000 Original-Received: from localhost ([127.0.0.1]:51395 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZOUPO-0001Ld-Ho for submit@debbugs.gnu.org; Sun, 09 Aug 2015 13:29:18 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40905) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZOUP4-0001Kx-G6 for submit@debbugs.gnu.org; Sun, 09 Aug 2015 13:29:17 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZOUP2-0000EZ-VW for submit@debbugs.gnu.org; Sun, 09 Aug 2015 13:28:58 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:56012) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUP2-0000EV-SK for submit@debbugs.gnu.org; Sun, 09 Aug 2015 13:28:56 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50911) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUP1-0007qF-VJ for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:28:56 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZOUOy-0000CO-N2 for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:28:55 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:49610) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZOUOy-0000C8-C2 for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2015 13:28:52 -0400 Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id t79HSoWJ014679 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sun, 9 Aug 2015 17:28:51 GMT Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by userv0021.oracle.com (8.13.8/8.13.8) with ESMTP id t79HSoXr016306 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Sun, 9 Aug 2015 17:28:50 GMT Original-Received: from abhmp0013.oracle.com (abhmp0013.oracle.com [141.146.116.19]) by aserv0122.oracle.com (8.13.8/8.13.8) with ESMTP id t79HSoos014800 for ; Sun, 9 Aug 2015 17:28:50 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6691.5000 (x86)] X-Source-IP: userv0021.oracle.com [156.151.31.71] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). 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: 208.118.235.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:105379 Archived-At: Argument WHEN is not described at all for some of these macros. For others it is described incorrectly or only via an example. It needs to be described clearly. The correct description is, in all cases, what is said in the Elisp manual for `make-obsolete': If provided, WHEN should be a string indicating when the function was first made obsolete=3D81\for example, a date or a release number. (with "function" replaced by "face" or "variable", as appropriate), except that "version number" is preferable to "release number". These macros are used by users and 3rd-party libraries too, not just by core Emacs development, and in such contexts "release" is not necessarily appropriate. The most important remark, however, is that "a date" should be offered as an example of a WHEN value, in addition to "a version number". The same change should be made for the Elisp manual, node `Variable Aliases'. It is better to say "for example, a date or a version number" than just "(usually a version number string)". In GNU Emacs 25.0.50.1 (i686-pc-mingw32) of 2015-07-03 on LEG570 Repository revision: 2b848fadd51e805b2f46da64c5958ea7f009048a Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --host=3D3Di686-pc-mingw32 --enable-checking=3D3Dyes,glyphs'