From: Teemu Likonen <tlikonen@iki.fi>
To: emacs-devel@gnu.org
Subject: Document that symbol prefix "my-" (or other) should be left for users
Date: Sun, 13 Dec 2015 20:16:28 +0200 [thread overview]
Message-ID: <87mvtekydf.fsf@mithlond.arda> (raw)
[-- Attachment #1: Type: text/plain, Size: 1495 bytes --]
It seems to me that Emacs users often use "my-" prefix or person's
initials (like "tl-" or "tl/") as prefix when writing their private
extensions and configuration. However, there is no officially documented
prefix which Emacs promises to leave for users. So I suggest making such
promise and documenting it in info page "(elisp) Coding Conventions"
(example patch below).
What is suitable prefix? It should be short. "my-" and "user-" are
already used somewhere.
--8<---------------cut here---------------start------------->8---
commit 526387c4d62f06d932f7885cc4f047a0fa255381
Author: Teemu Likonen <tlikonen@iki.fi>
Date: 2015-12-13 19:58:57 +0200
tips.texi: Document that symbol prefix `my-' is for users
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index ffce920..37186c6 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -89,6 +89,9 @@ Coding Conventions
If one prefix is insufficient, your package can use two or three
alternative common prefixes, so long as they make sense.
+Finally, prefix @code{my-} should be reserved for users, their private
+features and configuration. Don't use it in public packages.
+
@item
Put a call to @code{provide} at the end of each separate Lisp file.
@xref{Named Features}.
--8<---------------cut here---------------end--------------->8---
--
/// Teemu Likonen - .-.. <https://github.com/tlikonen> //
// PGP: 4E10 55DC 84E9 DFF6 13D7 8557 719D 69D3 2453 9450 ///
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 818 bytes --]
next reply other threads:[~2015-12-13 18:16 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-13 18:16 Teemu Likonen [this message]
2015-12-13 18:32 ` Document that symbol prefix "my-" (or other) should be left for users Drew Adams
2015-12-13 18:56 ` Teemu Likonen
2015-12-14 20:31 ` John Wiegley
2015-12-15 18:22 ` Tassilo Horn
2015-12-15 18:29 ` John Yates
2015-12-15 19:01 ` Drew Adams
2015-12-15 20:32 ` John Wiegley
2015-12-16 3:12 ` Evans Winner
2015-12-16 6:41 ` John Wiegley
2015-12-16 0:16 ` David Reitter
2015-12-16 1:26 ` Drew Adams
2015-12-16 1:39 ` Chad Brown
2015-12-16 1:52 ` Drew Adams
2015-12-16 4:41 ` Chad Brown
-- strict thread matches above, loose matches on Subject: below --
2022-07-10 3:39 Special Event: Davin reveals his own personal additions to Emacs Davin Pearson
2022-07-10 12:57 ` Stefan Monnier
2022-07-10 16:03 ` Document that symbol prefix "my-" (or other) should be left for users Teemu Likonen
2022-07-10 16:59 ` Stefan Kangas
2022-07-10 18:11 ` Bozhidar Batsov
2022-07-10 19:20 ` Tim Cross
2022-07-11 3:17 ` Richard Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mvtekydf.fsf@mithlond.arda \
--to=tlikonen@iki.fi \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.