From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: MON KEY Newsgroups: gmane.emacs.bugs Subject: bug#6525: documentation of macro `with-silent-modifications' 1 typo + multi-horrid Date: Mon, 28 Jun 2010 03:36:09 -0400 Message-ID: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: dough.gmane.org 1277711968 28976 80.91.229.12 (28 Jun 2010 07:59:28 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 28 Jun 2010 07:59:28 +0000 (UTC) To: 6525@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jun 28 09:59:27 2010 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.69) (envelope-from ) id 1OT9FX-0000DJ-6y for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 Jun 2010 09:59:27 +0200 Original-Received: from localhost ([127.0.0.1]:57058 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OT9FW-0002hI-C0 for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 Jun 2010 03:59:26 -0400 Original-Received: from [140.186.70.92] (port=53637 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OT9FQ-0002h8-11 for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:59:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OT9FO-0002H6-Oh for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:59:19 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44371) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OT9FO-0002H1-NJ for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:59:18 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1OT8tq-0005Xj-E0; Mon, 28 Jun 2010 03:37:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: MON KEY Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jun 2010 07:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 6525 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.127771057921294 (code B ref -1); Mon, 28 Jun 2010 07:37:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 28 Jun 2010 07:36:19 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OT8t9-0005XP-4f for submit@debbugs.gnu.org; Mon, 28 Jun 2010 03:36:19 -0400 Original-Received: from mail.gnu.org ([199.232.76.166] helo=mx10.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OT8t7-0005XK-2b for submit@debbugs.gnu.org; Mon, 28 Jun 2010 03:36:17 -0400 Original-Received: from lists.gnu.org ([199.232.76.165]:38228) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1OT8t4-0006mb-0H for submit@debbugs.gnu.org; Mon, 28 Jun 2010 03:36:14 -0400 Original-Received: from [140.186.70.92] (port=33131 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OT8t1-0007Cz-Rx for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:36:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OT8t0-0007cv-IO for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:36:11 -0400 Original-Received: from mail-pw0-f41.google.com ([209.85.160.41]:56343) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OT8t0-0007ck-Dv for bug-gnu-emacs@gnu.org; Mon, 28 Jun 2010 03:36:10 -0400 Original-Received: by pwi3 with SMTP id 3so332881pwi.0 for ; Mon, 28 Jun 2010 00:36:09 -0700 (PDT) Original-Received: by 10.114.30.6 with SMTP id d6mr4853367wad.135.1277710569039; Mon, 28 Jun 2010 00:36:09 -0700 (PDT) Original-Received: by 10.114.150.4 with HTTP; Mon, 28 Jun 2010 00:36:09 -0700 (PDT) X-Google-Sender-Auth: AhE7ICIFFskJOWn-WeGxnM9boMw X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Mon, 28 Jun 2010 03:37:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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: , 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:38067 Archived-At: documentation of macro `with-silent-modifications' lisp/subr.el current through Bzr-100654 There is a typo @ "... does not modifies the buffer." should be "... does not modify the buffer." More generally the docstring is bordering on non-sensical. ,---- (documentation 'with-silent-modifications) | | "Execute BODY, pretending it does not modifies the buffer. | If BODY performs real modifications to the buffer's text, other than | cosmetic ones, undo data may become corrupted. Typically used | around modifications of text-properties which do not really affect | the buffer's content." | `---- Execute BODY, pretending it does not modifies the buffer. ^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^ modify ^^^^^^|^^^^^ what is a `pretend' which buffer? If BODY performs real modifications to the buffer's text, other than ^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^ what is a non-real mod? ??? cosmetic ones, undo data may become corrupted. Typically used ^^^|^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^ what is non-cosmetic? | what is an atypical usage? | why not say `buffer-undo-list'? around modifications of text-properties which do not really affect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^ what is the affector txt-prop or the mod? the buffer's content. ^^^^^^^^^^^^^|^^^^^^ exactly what _is_ content - chars, tps, overlays, fields, faces? -- /s_P\