From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: Re: Documentation style Date: Fri, 15 Oct 2004 13:40:44 -0500 (CDT) Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Message-ID: <200410151840.i9FIeit09642@raven.dms.auburn.edu> References: <87y8i8t03j.fsf@oak.pohoyda.family> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1097865755 22192 80.91.229.6 (15 Oct 2004 18:42:35 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 15 Oct 2004 18:42:35 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Oct 15 20:42:26 2004 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1CIX21-0000b3-00 for ; Fri, 15 Oct 2004 20:42:25 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CIX9A-0004SX-PY for ged-emacs-devel@m.gmane.org; Fri, 15 Oct 2004 14:49:48 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CIX94-0004SQ-OY for emacs-devel@gnu.org; Fri, 15 Oct 2004 14:49:42 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CIX94-0004SE-Aq for emacs-devel@gnu.org; Fri, 15 Oct 2004 14:49:42 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CIX94-0004SB-4X for emacs-devel@gnu.org; Fri, 15 Oct 2004 14:49:42 -0400 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CIX1i-0008Kj-KQ for emacs-devel@gnu.org; Fri, 15 Oct 2004 14:42:06 -0400 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id i9FIfsiU009533; Fri, 15 Oct 2004 13:41:54 -0500 (CDT) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.7p1+Sun/8.11.7) id i9FIeit09642; Fri, 15 Oct 2004 13:40:44 -0500 (CDT) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: alexander.pohoyda@gmx.net In-reply-to: <87y8i8t03j.fsf@oak.pohoyda.family> (message from Alexander Pohoyda on 15 Oct 2004 18:30:56 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:28444 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:28444 Alexander Pohoyda wrote: I re-read the Documentation section in the manual, but didn't find the answer. Is there a reason to document variables like this: (defvar abcd nil "\ *Some variable..") or is it *fully* equivalent to this: (defvar abcd nil "Some variable..") The answer is at the end of `(elisp)Autoload': The backslash and newline immediately following the double-quote are a convention used only in the preloaded uncompiled Lisp files such as `loaddefs.el'; they tell `make-docfile' to put the documentation string in the `etc/DOC' file. *Note Building Emacs::. See also the commentary in `lib-src/make-docfile.c'. Sincerely, Luc.