Relating Symbols

Relating Symbols

[Nordlöw]

Every time I discover an obscurely named elisp function solving a
common problem I'm looking for I always add an alias (defalias)
connecting personal keywords I had in mind when search for the
function, variable, face etc with the symbol that does the job.

Once in a while I also find existing functions that I somehow want to
relate so I have a package which contains lots of dual put-calls like:

(put 'trace-function :related 'debug-on-entry)
(put 'debug-on-entry :related 'trace-function)

I know would like to this information to be displayed (at the end
preferrably) when I do describe-... on that symbol. Any tips on
realizing this using hooks or advices to the help functions?

Thanks in advance,
Nordlöw

Re: Relating Symbols

[Juanma Barranquero]

On Mon, Nov 30, 2009 at 10:28, Nordlöw <per.nordlow@gmail.com> wrote:

> I know would like to this information to be displayed (at the end
> preferrably) when I do describe-... on that symbol. Any tips on
> realizing this using hooks or advices to the help functions?

This is a crude first cut at implementing it:

(defadvice describe-function (after related activate compile)
  (let ((related (get (ad-get-arg 0) :related)))
    (when related
      (with-current-buffer (get-buffer "*Help*")
        (let ((buffer-read-only nil)
              (inhibit-changing-match-data t))
          (goto-char (point-max))
          (re-search-backward "\\[back\\]")
          (insert (format "Related: %s\n\n" related)))))))

though, if you want to allow related to be a list, or the inserted
function names to be links, you'll have to dig deeper.

    Juanma

Re: Relating Symbols

[Pascal J. Bourguignon]

Nordlöw <per.nordlow@gmail.com> writes:

> Every time I discover an obscurely named elisp function solving a
> common problem I'm looking for I always add an alias (defalias)
> connecting personal keywords I had in mind when search for the
> function, variable, face etc with the symbol that does the job.
>
> Once in a while I also find existing functions that I somehow want to
> relate so I have a package which contains lots of dual put-calls like:
>
> (put 'trace-function :related 'debug-on-entry)
> (put 'debug-on-entry :related 'trace-function)
>
> I know would like to this information to be displayed (at the end
> preferrably) when I do describe-... on that symbol. Any tips on
> realizing this using hooks or advices to the help functions?

Use the source!

Same as your previous function.  Do you think we remember all these
answers?  It's always the same thing. You want something about
next-error, ok, C-h f next-error RET C-x o TAB RET and read the
source!

Idem here, C-h f describe-function RET C-x o TAB RET and read the doc
and the source!

In my emacs instance, the doc of describe-function  note that it is
adviced.  Perhaps you could do the same, and add an advice to add the
descriptions you want?  (See defadvise).


-- 
__Pascal Bourguignon__

Re: Relating Symbols

[harven]

pjb@informatimago.com (Pascal J. Bourguignon) writes:

> Nordlöw <per.nordlow@gmail.com> writes:

> Use the source!
>
> Same as your previous function.  Do you think we remember all these
> answers?  It's always the same thing. You want something about
> next-error, ok, C-h f next-error RET C-x o TAB RET and read the
> source!

I recently used a linux debian system and it seems that the elisp
sources are not shipped with a standard install on this distribution.
In fact there are only compiled .elc files on the system. This is a
pity IMHO.

I can grab the .el files from the emacs site, but I'm not sure where
to put them, so that they become available through the help bindings.
Besides that, they probably will be wipped out by the next automatic
upgrade.

Any solution to recover the sources, without recompiling everything ?

Re: Relating Symbols

[Renaud Casenave-Péré]

From: harven <harven@free.fr>
Subject: Re: Relating Symbols
Date: Mon, 30 Nov 2009 15:25:00 +0100

> pjb@informatimago.com (Pascal J. Bourguignon) writes:
> 
>> Nordlöw <per.nordlow@gmail.com> writes:
> 
>> Use the source!
>>
>> Same as your previous function.  Do you think we remember all these
>> answers?  It's always the same thing. You want something about
>> next-error, ok, C-h f next-error RET C-x o TAB RET and read the
>> source!
> 
> I recently used a linux debian system and it seems that the elisp
> sources are not shipped with a standard install on this distribution.
> In fact there are only compiled .elc files on the system. This is a
> pity IMHO.
> 
> I can grab the .el files from the emacs site, but I'm not sure where
> to put them, so that they become available through the help bindings.
> Besides that, they probably will be wipped out by the next automatic
> upgrade.
> 
> Any solution to recover the sources, without recompiling everything ?

`aptitude install emacs23-el' ?

the elisp sources files are shipped within a different package.

-- 
Renaud Casenave-Péré

Re: Relating Symbols

[harven]

Renaud Casenave-Péré <renaud@casenave-pere.fr> writes:
>>> Nordlöw <per.nordlow@gmail.com> writes:
>> 
>>> Use the source!
>>>
>>> Same as your previous function.  Do you think we remember all these
>>> answers?  It's always the same thing. You want something about
>>> next-error, ok, C-h f next-error RET C-x o TAB RET and read the
>>> source!
>> 
>> I recently used a linux debian system and it seems that the elisp
>> sources are not shipped with a standard install on this distribution.
>> In fact there are only compiled .elc files on the system. This is a
>> pity IMHO.
>> 
>> I can grab the .el files from the emacs site, but I'm not sure where
>> to put them, so that they become available through the help bindings.
>> Besides that, they probably will be wipped out by the next automatic
>> upgrade.
>> 
>> Any solution to recover the sources, without recompiling everything ?
>
> `aptitude install emacs23-el' ?
>
> the elisp sources files are shipped within a different package.

Thanks !

Re: Relating Symbols

[Pascal J. Bourguignon]

harven <harven@free.fr> writes:
> Any solution to recover the sources, without recompiling everything ?

Downloading and compiling emacs is a five minute affair.


-- 
__Pascal Bourguignon__

Re: Relating Symbols

[Tim X]

harven <harven@free.fr> writes:

> pjb@informatimago.com (Pascal J. Bourguignon) writes:
>
>> Nordlöw <per.nordlow@gmail.com> writes:
>
>> Use the source!
>>
>> Same as your previous function.  Do you think we remember all these
>> answers?  It's always the same thing. You want something about
>> next-error, ok, C-h f next-error RET C-x o TAB RET and read the
>> source!
>
> I recently used a linux debian system and it seems that the elisp
> sources are not shipped with a standard install on this distribution.
> In fact there are only compiled .elc files on the system. This is a
> pity IMHO.
>
> I can grab the .el files from the emacs site, but I'm not sure where
> to put them, so that they become available through the help bindings.
> Besides that, they probably will be wipped out by the next automatic
> upgrade.
>
> Any solution to recover the sources, without recompiling everything ?

Yep, The sources are in their own package. Just install it.

Tim

-- 
tcross (at) rapttech dot com dot au