From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Michael Witten Newsgroups: gmane.emacs.bugs Subject: bug#11862: [PATCH 8b/2] doc/lispref/intro.texi: Reduce and reorganize node `A sample Variable Description' Date: Fri, 06 Jul 2012 20:18:15 -0000 Message-ID: <8c3793fd59b640d4887f7f0965fbecda-mfwitten@gmail.com> References: <22f1c29cd7e44a3e91ca67e534dc03a4-mfwitten@gmail.com> <3c1c3c1cfe3840e19551bfd0424eb99d-mfwitten@gmail.com> <0c2cb6909a904ffeb3010bf4ca2e40b2-mfwitten@gmail.com> <85pq88c0nj.fsf@iznogoud.viz> <31927313f03b410aaa9830427ff3a0c1-mfwitten@gmail.com> NNTP-Posting-Host: plane.gmane.org X-Trace: dough.gmane.org 1341607451 29083 80.91.229.3 (6 Jul 2012 20:44:11 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 6 Jul 2012 20:44:11 +0000 (UTC) Cc: 11862@debbugs.gnu.org, Wolfgang Jenkner , Richard Stallman To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 06 22:44:10 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 1SnFNp-00046p-65 for geb-bug-gnu-emacs@m.gmane.org; Fri, 06 Jul 2012 22:44:09 +0200 Original-Received: from localhost ([::1]:48639 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SnFNo-0004kk-7n for geb-bug-gnu-emacs@m.gmane.org; Fri, 06 Jul 2012 16:44:08 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:45054) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SnFNl-0004kY-9S for bug-gnu-emacs@gnu.org; Fri, 06 Jul 2012 16:44:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SnFNj-0002Cg-Bc for bug-gnu-emacs@gnu.org; Fri, 06 Jul 2012 16:44:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:43711) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SnFNj-0002Cb-5b for bug-gnu-emacs@gnu.org; Fri, 06 Jul 2012 16:44:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1SnFSY-0007XO-87 for bug-gnu-emacs@gnu.org; Fri, 06 Jul 2012 16:49:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Michael Witten Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 06 Jul 2012 20:49:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 11862 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 11862-submit@debbugs.gnu.org id=B11862.134160768728902 (code B ref 11862); Fri, 06 Jul 2012 20:49:02 +0000 Original-Received: (at 11862) by debbugs.gnu.org; 6 Jul 2012 20:48:07 +0000 Original-Received: from localhost ([127.0.0.1]:53254 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1SnFRe-0007W7-JT for submit@debbugs.gnu.org; Fri, 06 Jul 2012 16:48:06 -0400 Original-Received: from mail-pb0-f44.google.com ([209.85.160.44]:55358) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1SnFRa-0007UV-GG for 11862@debbugs.gnu.org; Fri, 06 Jul 2012 16:48:04 -0400 Original-Received: by mail-pb0-f44.google.com with SMTP id wy7so14032056pbc.3 for <11862@debbugs.gnu.org>; Fri, 06 Jul 2012 13:43:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=subject:date:from:to:cc:message-id:in-reply-to:references; bh=YfjDT0B/SIDx1o/twOwArjlSRlH8iyvwtSAwwUinEf4=; b=WFTGJ+oIBq1YvGAKSa6fhJ62nQErQXayr+nf7WdqIW+KXzCREK+qEn2HuZIJTRoeki ReE94pAQ3CM5KSZjCFfCeYFyOazbpHgwZQkzpiJTiAdlrHY55AQy5PhAJRqTbXYa2jN2 ORRweawc3+1m8JtDC3vEjqrAbEDgdd+XYP9u2uImWo7vP+stsnnziuf+wBK0gJX42YKJ +w0HBi6p1nqvuQs0ojYrNtWQHAgVqXa49LeL/HUoQ1NlnXOYhNhPmWzgJPNLIUF/Qo2L 9c9CGh/oXBdKJW76RDUxRLv8PMgmxEy0IYLHBqe96tTQf13GwkyjSVTmD2zX5W2Jh/DR xgmw== Original-Received: by 10.68.201.7 with SMTP id jw7mr39462019pbc.60.1341607382290; Fri, 06 Jul 2012 13:43:02 -0700 (PDT) Original-Received: from gmail.com ([188.127.231.134]) by mx.google.com with ESMTPS id nv6sm22490091pbc.42.2012.07.06.13.42.57 (version=TLSv1/SSLv3 cipher=OTHER); Fri, 06 Jul 2012 13:43:01 -0700 (PDT) In-Reply-To: <31927313f03b410aaa9830427ff3a0c1-mfwitten@gmail.com> 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:61667 Archived-At: The description of `variable' is removed; such a descriptin is better placed in the node `Variables'. Moreover, this change is consistent with the text of the sibling node, `A Sample Function Description', which does not give such a description for a function, instead leaving that complex topic to more appropriate nodes (such as node `Functions'). The term `user options' is moved to the bottom of the node. --- doc/lispref/intro.texi | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi index 0766a23..b62bceb 100644 --- a/doc/lispref/intro.texi +++ b/doc/lispref/intro.texi @@ -447,14 +447,9 @@ from @var{body}, which includes all remaining elements of the form. @cindex variable descriptions @cindex option descriptions - A @dfn{variable} is a name that can hold a value. Although nearly -all variables can be set by the user, certain variables exist -specifically so that users can change them; these are called @dfn{user -options}. Ordinary variables and user options are described using a -format like that for functions except that there are no arguments. - - Here is a description of the imaginary @code{electric-future-map} -variable.@refill +Variables are described using a format like that for functions, except +that there are no arguments. Here is a description of the imaginary +@code{electric-future-map} variable.@refill @defvar electric-future-map The value of this variable is a full keymap used by Electric Command @@ -462,8 +457,10 @@ Future mode. The functions in this map allow you to edit commands you have not yet thought about executing. @end defvar - User option descriptions have the same format, but `Variable' is -replaced by `User Option'. +Although nearly all variables can be set by the user, certain variables +exist specifically so that users can change them; these are called +@dfn{user options}. User option descriptions have the same format, +but `Variable' is replaced by `User Option'. @node Version Info @section Version Information -- 1.7.11.1.29.gf71be5c