From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.help Subject: RE: About definition finding Date: Wed, 6 Mar 2013 08:11:44 -0800 Message-ID: References: <5137446A.1060505@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1362586327 17158 80.91.229.3 (6 Mar 2013 16:12:07 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 6 Mar 2013 16:12:07 +0000 (UTC) To: "'Xue Fuqiao'" , Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Wed Mar 06 17:12:31 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 1UDGx6-0007Gl-A4 for geh-help-gnu-emacs@m.gmane.org; Wed, 06 Mar 2013 17:12:24 +0100 Original-Received: from localhost ([::1]:45165 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDGwk-0007AG-KT for geh-help-gnu-emacs@m.gmane.org; Wed, 06 Mar 2013 11:12:02 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:51859) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDGwa-0007AA-FL for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 11:11:53 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UDGwY-0007yJ-Kw for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 11:11:52 -0500 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:26010) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDGwY-0007y6-EM for help-gnu-emacs@gnu.org; Wed, 06 Mar 2013 11:11:50 -0500 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r26GBlBP021637 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Wed, 6 Mar 2013 16:11:48 GMT Original-Received: from acsmt356.oracle.com (acsmt356.oracle.com [141.146.40.156]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r26GBlU9006899 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Wed, 6 Mar 2013 16:11:47 GMT Original-Received: from abhmt110.oracle.com (abhmt110.oracle.com [141.146.116.62]) by acsmt356.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r26GBlIc023090; Wed, 6 Mar 2013 10:11:47 -0600 Original-Received: from dradamslap1 (/10.159.176.209) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Wed, 06 Mar 2013 08:11:47 -0800 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <5137446A.1060505@gmail.com> Thread-Index: Ac4abobDRivn7StVRE+XHnpXotA6LwAFeL8g X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-Received-From: 141.146.126.69 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:89387 Archived-At: > 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. 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.