From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Xue Fuqiao Newsgroups: gmane.emacs.help Subject: Re: About definition finding Date: Thu, 07 Mar 2013 06:18:38 +0800 Organization: The Church of Emacs Message-ID: <5137C0BE.1060601@gmail.com> References: <5137446A.1060505@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1362608335 12471 80.91.229.3 (6 Mar 2013 22:18:55 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 6 Mar 2013 22:18:55 +0000 (UTC) Cc: help-gnu-emacs@gnu.org To: Drew Adams Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Wed Mar 06 23:19:19 2013 Return-path: Envelope-to: geh-help-gnu-emacs@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 1UDMgA-0000Mt-Hv for geh-help-gnu-emacs@m.gmane.org; Wed, 06 Mar 2013 23:19:18 +0100 Original-Received: from localhost ([::1]:53933 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDMfo-0001je-QO for geh-help-gnu-emacs@m.gmane.org; Wed, 06 Mar 2013 17:18:56 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:57858) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDMfd-0001h9-V2 for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 17:18:47 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UDMfc-0001rQ-81 for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 17:18:45 -0500 Original-Received: from mail-pb0-f41.google.com ([209.85.160.41]:50670) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDMfb-0001rE-JR for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 17:18:44 -0500 Original-Received: by mail-pb0-f41.google.com with SMTP id um15so6659562pbc.0 for ; Wed, 06 Mar 2013 14:18:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:message-id:date:from:organization:user-agent :mime-version:to:cc:subject:references:in-reply-to:content-type :content-transfer-encoding; bh=d2zu0WZXziNAa3By+QLFP5KsBu/6NVpYsj6D4Sa6me8=; b=Z+dyOMoXGf68caXd9V05R/nJid4YQBj9InWPTlYujhAfvuGQqBur4GqgPSwkmk0PNI +13u7BI5gXazG/v3nTSadEXtEuVi4K2X7r+S1df3KrBQHPx1s3TjocdoyuyHAkdTyv86 NEQILb7B4DHCaYPANH/GuQbi6aHWc0QBT5No3qrxYifs3SsQOdOsBt+DQdKFN6nSPcj9 mLuwwWfoysFfJrU6MgHHlPqOuxLWU2lvdxPktFZLv5mlJFu85+Zlnk1pLk30Lfzx5YMP TmtZ/bPcYouHhw1KzbUvhpEh0t++RT5OaZxyvOcJVPTNRUtCxu2iXOge+uQwETel/Y6D rIGw== X-Received: by 10.68.197.133 with SMTP id iu5mr48792376pbc.195.1362608322578; Wed, 06 Mar 2013 14:18:42 -0800 (PST) Original-Received: from [192.168.1.103] ([123.114.123.187]) by mx.google.com with ESMTPS id hu2sm33012073pbc.38.2013.03.06.14.18.40 (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 06 Mar 2013 14:18:41 -0800 (PST) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130221 Thunderbird/17.0.3 In-Reply-To: X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 209.85.160.41 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:89395 Archived-At: On 03/07/2013 12:11 AM, Drew Adams wrote: >> In (info "(elisp) Coding Conventions"): >> >> * Constructs that define a function or variable should be macros, >> not functions, and their names should start with `define-'. The >> macro should receive the name to be defined as the >> first argument. >> That will help various tools find the definition automatically. >> Avoid constructing the names in the macro itself, since >> that would confuse these tools. >> >> Which tools will make use of it? Imenu/etags/...? I'm not quite >> familiar with it. Can anybody help? Thanks. > > Yes, both Imenu and Emacs tags. And perhaps other tools that you might write to > take advantage of such a convention. Ah, I see, thanks. > Note that this doc section's guideline conflicts a bit with that of adding a > package/library prefix to such macros. E.g., `icicle-define-command' vs > `define-icicle-command'. I put the library prefix first, but others might do > otherwise. Does alias make sense? E.g., `package-list-packages' is an alias of `list-packages'. -- Best regards, Xue Fuqiao. http://www.emacswiki.org/emacs/XueFuqiao