unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Marcin Borkowski <mbork@mbork.pl>
To: Help Gnu Emacs mailing list <help-gnu-emacs@gnu.org>
Subject: How does `describe-function' know where the source code of the function is?
Date: Mon, 17 Jan 2022 05:03:50 +0100	[thread overview]
Message-ID: <87pmorf1p5.fsf@mbork.pl> (raw)

Hi all,

If I define a function with `defun', C-h f gives me a link to the source
code of the function.  I defined a macro defining a function (its
expansion contained a `defun'), and C-h f'ing that function did /not/
give me that link.  I tried saying M-: (symbol-plist 'my-function), but
I haven't seen any property that would point to the source code.  So, my
question is: how does `describe-function' know where the link should
point to (and if it should be rendered at all)?  I skimmed its source
code, but it seems pretty convoluted.  I found
`help-fns-function-description-header', but it seems that the actual
code finding the exact position of the function definition is buried
deep down the call chain, so I'm asking here in the hope that someone
could point me to the right place faster than me trying to edebug this
or something.

TIA,

-- 
Marcin Borkowski
http://mbork.pl



             reply	other threads:[~2022-01-17  4:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-17  4:03 Marcin Borkowski [this message]
2022-01-17  4:14 ` How does `describe-function' know where the source code of the function is? Emanuel Berg via Users list for the GNU Emacs text editor
2022-01-17  4:27 ` Eduardo Ochs
2022-01-17 16:22 ` Michael Heerdegen
2022-01-18  2:51 ` Stefan Monnier via Users list for the GNU Emacs text editor
2022-01-18 17:41   ` Marcin Borkowski
2022-01-18 18:46     ` Stefan Monnier

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87pmorf1p5.fsf@mbork.pl \
    --to=mbork@mbork.pl \
    --cc=help-gnu-emacs@gnu.org \
    /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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).