all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Xue Fuqiao'" <xfq.free@gmail.com>, <help-gnu-emacs@gnu.org>
Subject: RE: About definition finding
Date: Wed, 6 Mar 2013 08:11:44 -0800	[thread overview]
Message-ID: <EC3C5824D50B4C74921D968BB6F2C0AC@us.oracle.com> (raw)
In-Reply-To: <5137446A.1060505@gmail.com>

> 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.




  reply	other threads:[~2013-03-06 16:11 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-06 13:28 About definition finding Xue Fuqiao
2013-03-06 16:11 ` Drew Adams [this message]
2013-03-06 22:18   ` Xue Fuqiao
2013-03-06 22:31     ` Drew Adams
2013-03-06 22:41       ` Xue Fuqiao
     [not found] <mailman.21544.1362576522.855.help-gnu-emacs@gnu.org>
2013-03-06 18:05 ` Michael Heerdegen

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=EC3C5824D50B4C74921D968BB6F2C0AC@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=help-gnu-emacs@gnu.org \
    --cc=xfq.free@gmail.com \
    /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.