diff options
| author | Christopher Schmidt | 2013-04-15 19:01:00 +0200 |
|---|---|---|
| committer | Christopher Schmidt | 2013-04-15 19:01:00 +0200 |
| commit | 8fa2654ed8fd2118b8a3120e2b4f9857e6a96239 (patch) | |
| tree | 9febe12fa205446352e43c52bd85943177d6a078 | |
| parent | 20e527d0c5e5a4ba95f14ab1d0379c20557406ae (diff) | |
| download | emacs-8fa2654ed8fd2118b8a3120e2b4f9857e6a96239.tar.gz emacs-8fa2654ed8fd2118b8a3120e2b4f9857e6a96239.zip | |
* etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention
separation of package descriptor and name of internal symbols by
two hyphens.
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/tips.texi | 16 | ||||
| -rw-r--r-- | etc/ChangeLog | 5 | ||||
| -rw-r--r-- | etc/NEWS | 6 |
4 files changed, 25 insertions, 7 deletions
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 @@ | |||
| 1 | 2013-04-15 Christopher Schmidt <christopher@ch.ristopher.com> | ||
| 2 | |||
| 3 | * tips.texi (Coding Conventions): Mention separation of package | ||
| 4 | descriptor and name of internal symbols by two hyphens. | ||
| 5 | |||
| 1 | 2013-04-13 Stephen Berman <stephen.berman@gmx.net> | 6 | 2013-04-13 Stephen Berman <stephen.berman@gmx.net> |
| 2 | 7 | ||
| 3 | * windows.texi (Splitting Windows): Change category of | 8 | * 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. | |||
| 51 | 51 | ||
| 52 | @item | 52 | @item |
| 53 | You should choose a short word to distinguish your program from other | 53 | You should choose a short word to distinguish your program from other |
| 54 | Lisp programs. The names of all global variables, constants, and | 54 | Lisp programs. The names of all global symbols in your program, that |
| 55 | functions in your program should begin with that chosen prefix. | 55 | is the names of variables, constants, and functions, should begin with |
| 56 | Separate the prefix from the rest of the name with a hyphen, @samp{-}. | 56 | that chosen prefix. Separate the prefix from the rest of the name |
| 57 | This practice helps avoid name conflicts, since all global variables | 57 | with a hyphen, @samp{-}. Use two hyphens if the symbol is not meant |
| 58 | in Emacs Lisp share the same name space, and all functions share | 58 | to be used by other packages. This practice helps avoid name |
| 59 | another name space@footnote{The benefits of a Common Lisp-style | 59 | conflicts, since all global variables in Emacs Lisp share the same |
| 60 | package system are considered not to outweigh the costs.}. | 60 | name space, and all functions share another name space@footnote{The |
| 61 | benefits of a Common Lisp-style package system are considered not to | ||
| 62 | outweigh the costs.}. | ||
| 61 | 63 | ||
| 62 | Occasionally, for a command name intended for users to use, it is more | 64 | Occasionally, for a command name intended for users to use, it is more |
| 63 | convenient if some words come before the package's name prefix. And | 65 | 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 @@ | |||
| 1 | 2013-04-15 Christopher Schmidt <christopher@ch.ristopher.com> | ||
| 2 | |||
| 3 | * NEWS: Mention separation of package descriptor and name of | ||
| 4 | internal symbols by two hyphens. | ||
| 5 | |||
| 1 | 2013-04-13 Stephen Berman <stephen.berman@gmx.net> | 6 | 2013-04-13 Stephen Berman <stephen.berman@gmx.net> |
| 2 | 7 | ||
| 3 | * NEWS: Mention fixing `split-window' to be non-interactive. | 8 | * NEWS: Mention fixing `split-window' to be non-interactive. |
| @@ -409,6 +409,12 @@ used in place of the 9th element of `file-attributes'. | |||
| 409 | `preserve-extended-attributes' as it now handles both SELinux context | 409 | `preserve-extended-attributes' as it now handles both SELinux context |
| 410 | and ACL entries. | 410 | and ACL entries. |
| 411 | 411 | ||
| 412 | ** Changes to the Emacs Lisp Coding Conventions in Emacs 24.4 | ||
| 413 | |||
| 414 | *** The package descriptor and name of global variables, constants, | ||
| 415 | and functions should be separated by two hypens if the symbol is not | ||
| 416 | meant to be used by other packages. | ||
| 417 | |||
| 412 | 418 | ||
| 413 | * Changes in Emacs 24.4 on Non-Free Operating Systems | 419 | * Changes in Emacs 24.4 on Non-Free Operating Systems |
| 414 | 420 | ||