From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Christopher Schmidt Newsgroups: gmane.emacs.devel Subject: Re: Naming internal functions Date: Mon, 15 Apr 2013 14:46:26 +0100 (BST) Message-ID: <87li8joqil@ch.ristopher.com> References: <87hajhswdh.fsf@gmail.com> <87y5csu7ml.fsf@gmail.com> <87zjx8ivyb.fsf_-_@earth.home> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: ger.gmane.org 1366033601 7150 80.91.229.3 (15 Apr 2013 13:46:41 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 15 Apr 2013 13:46:41 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 15 15:46:43 2013 Return-path: Envelope-to: ged-emacs-devel@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 1URjk1-0007l5-7j for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2013 15:46:41 +0200 Original-Received: from localhost ([::1]:57534 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URjk0-0002ms-HY for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2013 09:46:40 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40099) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URjjs-0002fe-JA for emacs-devel@gnu.org; Mon, 15 Apr 2013 09:46:36 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1URjjp-0004UF-JP for emacs-devel@gnu.org; Mon, 15 Apr 2013 09:46:32 -0400 Original-Received: from ristopher.com ([146.185.21.93]:40190 helo=saturn.ch.ristopher.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URjjp-0004U0-AW for emacs-devel@gnu.org; Mon, 15 Apr 2013 09:46:29 -0400 Original-Received: by saturn.ch.ristopher.com (Postfix, from userid 0) id 8A4B520E13; Mon, 15 Apr 2013 14:46:26 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=ch.ristopher.com; s=mail; t=1366033586; bh=1lfFAUbO0jD2jMbqGyuLb0VMzfl5xn8j2mkd/XRYlbs=; h=From:To:Subject:In-Reply-To:Message-ID:References:MIME-Version: Content-Type:Date; b=W3wm7aJLd2tEwp0MNYxln6AvAo4Oz8tSOMse/uEI/Gv1gUBVKFSMCaPfAyfWVAz9y HY34J/9/DHT7f5q4Xjgnilc6/3R8j2Uuw/0UzjJDY78vnzrCz0beFjzFygEznE5WcT Wu6KqbOQtuqcwakAL5ojWjVYkYxxjXtxybpS0P4w= In-Reply-To: (Stefan Monnier's message of "Mon, 08 Apr 2013 17:28:46 -0400") Mail-Followup-To: emacs-devel@gnu.org X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x X-Received-From: 146.185.21.93 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 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 Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:158924 Archived-At: --=-=-= Content-Type: text/plain Stefan Monnier writes: >> I would like to propose a tweak to the prefix convention. >> (info "(elisp)Coding Conventions") >> Let's separate package and name of internal functions or variables >> with two consecutive dashes. > > Sounds good, tho a suggested patch would be welcome. --=-=-= Content-Type: text/x-diff Content-Disposition: inline --- doc/lispref/tips.texi +++ doc/lispref/tips.texi @@ -54,9 +54,10 @@ Lisp programs. The names of all global variables, constants, and functions in your program should begin with that chosen prefix. Separate the prefix from the rest of the name with a hyphen, @samp{-}. -This practice helps avoid name conflicts, since all global variables -in Emacs Lisp share the same name space, and all functions share -another name space@footnote{The benefits of a Common Lisp-style +Use two hyphens if the object is not meant to be used by other +packages. This practice helps avoid name conflicts, since all global +variables in Emacs Lisp share the same name space, and all functions +share another name space@footnote{The benefits of a Common Lisp-style package system are considered not to outweigh the costs.}. Occasionally, for a command name intended for users to use, it is more --- etc/NEWS +++ etc/NEWS @@ -409,6 +409,12 @@ `preserve-extended-attributes' as it now handles both SELinux context and ACL entries. +** Changes to the Emacs Lisp Coding Conventions in Emacs 24.4 + +*** The package descriptor and name of global variables, constants, +and functions should be separated by two hypens if the object is not +meant to be used by other packages. + * Changes in Emacs 24.4 on Non-Free Operating Systems --=-=-= Content-Type: text/plain Christopher --=-=-=--