diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2017-08-12 10:54:32 -0700 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2017-08-12 10:55:40 -0700 |
| commit | 9eb30cb03613ae158c870d603a05a6a6393dc485 (patch) | |
| tree | 632e1b57f6259232af8144fc93ce2b839294ffee /doc/lispref/variables.texi | |
| parent | 81e22163ebce94d4a3f77e089ee86b8efc6a36f4 (diff) | |
| download | emacs-9eb30cb03613ae158c870d603a05a6a6393dc485.tar.gz | |
Document internal-use naming conventions
* doc/lispref/functions.texi (Function Names):
* doc/lispref/variables.texi (Tips for Defining):
Document naming conventions for internal-use functions and vars.
See Bug#28023#59.
Diffstat (limited to 'doc/lispref/variables.texi')
| -rw-r--r-- | doc/lispref/variables.texi | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 2818ea067d2..7650ed4e3d8 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi @@ -574,6 +574,16 @@ The value is a whole shell command. @item @dots{}-switches The value specifies options for a command. + +@item @var{prefix}--@dots{} +The variable is intended for internal use and is defined in the file +@file{@var{prefix}.el}. (Emacs code contributed before 2018 may +follow other conventions, which are being phased out.) + +@item @dots{}-internal +The variable is intended for internal use and is defined in C code. +(Emacs code contributed before 2018 may follow other conventions, +which are being phased out.) @end table When you define a variable, always consider whether you should mark |