[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Document that symbol prefix "my-" (or other) should be left for users

From: Teemu Likonen
Subject: Document that symbol prefix "my-" (or other) should be left for users
Date: Sun, 13 Dec 2015 20:16:28 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5.50 (gnu/linux)

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 <address@hidden>
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.
 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: signature.asc
Description: PGP signature

reply via email to

[Prev in Thread] Current Thread [Next in Thread]