From: Christopher Schmidt Date: Mon, 15 Apr 2013 17:01:00 +0000 (+0200) Subject: * etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention X-Git-Tag: emacs-24.3.90~173^2^2~42^2~45^2~387^2~2026^2~458 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8fa2654ed8fd2118b8a3120e2b4f9857e6a96239;p=emacs.git * etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention separation of package descriptor and name of internal symbols by two hyphens. --- diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index f65c2e85461..31e4f791350 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,8 @@ +2013-04-15 Christopher Schmidt + + * tips.texi (Coding Conventions): Mention separation of package + descriptor and name of internal symbols by two hyphens. + 2013-04-13 Stephen Berman * windows.texi (Splitting Windows): Change category of diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 4c443da3af8..c40ae408f7f 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -51,13 +51,15 @@ don't postpone it. @item You should choose a short word to distinguish your program from other -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 -package system are considered not to outweigh the costs.}. +Lisp programs. The names of all global symbols in your program, that +is the names of variables, constants, and functions, should begin with +that chosen prefix. Separate the prefix from the rest of the name +with a hyphen, @samp{-}. Use two hyphens if the symbol 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 convenient if some words come before the package's name prefix. And diff --git a/etc/ChangeLog b/etc/ChangeLog index 31d14b96d94..2b7534dc1e7 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog @@ -1,3 +1,8 @@ +2013-04-15 Christopher Schmidt + + * NEWS: Mention separation of package descriptor and name of + internal symbols by two hyphens. + 2013-04-13 Stephen Berman * NEWS: Mention fixing `split-window' to be non-interactive. diff --git a/etc/NEWS b/etc/NEWS index 1e072afaaf1..0830a7be469 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -409,6 +409,12 @@ used in place of the 9th element of `file-attributes'. `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 symbol is not +meant to be used by other packages. + * Changes in Emacs 24.4 on Non-Free Operating Systems