From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Teemu Likonen Newsgroups: gmane.emacs.devel Subject: Document that symbol prefix "my-" (or other) should be left for users Date: Sun, 13 Dec 2015 20:16:28 +0200 Message-ID: <87mvtekydf.fsf@mithlond.arda> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Trace: ger.gmane.org 1450030625 13835 80.91.229.3 (13 Dec 2015 18:17:05 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 13 Dec 2015 18:17:05 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 13 19:16:53 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1a8BCW-0008S2-0l for ged-emacs-devel@m.gmane.org; Sun, 13 Dec 2015 19:16:52 +0100 Original-Received: from localhost ([::1]:56156 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a8BCV-0005cw-3z for ged-emacs-devel@m.gmane.org; Sun, 13 Dec 2015 13:16:51 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50222) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a8BCP-0005Ya-Tk for emacs-devel@gnu.org; Sun, 13 Dec 2015 13:16:46 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1a8BCK-0005QE-Tt for emacs-devel@gnu.org; Sun, 13 Dec 2015 13:16:45 -0500 Original-Received: from mta-out1.inet.fi ([62.71.2.232]:59008 helo=johanna1.inet.fi) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a8BCK-0005Ok-IS for emacs-devel@gnu.org; Sun, 13 Dec 2015 13:16:40 -0500 RazorGate-KAS: Status: not_detected RazorGate-KAS: Rate: 0 RazorGate-KAS: Envelope from: RazorGate-KAS: Version: 5.5.3 RazorGate-KAS: LuaCore: 80 2014-11-10_18-01-23 260f8afb9361da3c7edfd3a8e3a4ca908191ad29 RazorGate-KAS: Lua profiles 69136 [Nov 12 2014] RazorGate-KAS: Method: none Original-Received: from mithlond.arda (84.251.143.106) by johanna1.inet.fi (9.0.002.03-2-gbe5d057) id 56697A80004C55ED for emacs-devel@gnu.org; Sun, 13 Dec 2015 20:16:31 +0200 Original-Received: from dtw by mithlond.arda with local (Exim 4.84) (envelope-from ) id 1a8BCB-0003w3-BE for emacs-devel@gnu.org; Sun, 13 Dec 2015 20:16:31 +0200 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5.50 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 62.71.2.232 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:196213 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable 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. =2D-8<---------------cut here---------------start------------->8--- commit 526387c4d62f06d932f7885cc4f047a0fa255381 Author: Teemu Likonen 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 =2D-- 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. =20 +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}. =2D-8<---------------cut here---------------end--------------->8--- =2D-=20 /// Teemu Likonen - .-.. // // PGP: 4E10 55DC 84E9 DFF6 13D7 8557 719D 69D3 2453 9450 /// --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJWbbX/AAoJEHGdadMkU5RQdy8P/3d4xEPu7TXkq0bkGvcRGbUp lWzyYzhqxbH5vdVUW7mjCZ+D0pc+12Cy/gYug5y1gmNy0w8ZFUovCiL5uyYxog0M KSrcfPALZXOGFg+ECsqiZyMXwf+vs0d+xD8qUV91xL5KoyhSCLgfUFXgzYbiBd09 CQ7wd5BhJMn5JPoWowsH4tz2kHOjByeUL6R1Wb5dZj3wwjV/9vYdAgBuVj1PYYRc m2LF3UES+GLQ2IVsoYRiyVGu1DrraAMxCPv1PvBVj6w5ev1qARkL+5XacKgG3NXx YMLuwq/XmxA1/0IbaUS40dNd779QJ5wZ/0jQYvoILyOtS71MyKetrPHFMuqfT02c Tln6E8npJMTjFoWs4CGNaryG88A8C7wUO1h6TmQeJqVjBJteazhoJNBYwDiYPHnX mzePBasA9XQd/yUttfmwjKkRIq879KlmC/B4LYQcL7Fbkw1ZZwdM8HQTh2ZDiRf3 n9MtUc4PoYQ+PAq7wtKprJ3fyyLF56BGgxAF5aiSb+hdI42cpKBMuLn4t8vk8LFV WA8UObxFXL3Lw2cHx3lQwFWY8pwzKiWffPFf7Ib/RITc3LDYtx4injfK6fQwJIqK ixJu9IBvOFQDuRvPYEvaluRwgNL1kBmWCn9+wOJhDHvL0EsyZTBr6xjFgr7435YD uv1srtDlBY7K37PxZ7vc =1nFx -----END PGP SIGNATURE----- --=-=-=--