Moving to a literate file for .emacs

Moving to a literate file for .emacs

[Stephen Eglen]

I see many users are switching to using a 'literate programming'
approach to tangling their .emacs file from an org file.

Has anyone solved the following problem though?  If I have a file called
config.org containing:

* test

#+begin_src emacs-lisp
  (defun quick-test ()
    "interactive"
    (* 3 9)
  )
#+end_src


and then in my .emacs file I do:

(org-babel-load-file "~/config.org")

quick-test is indeed defined, but when I do C-c f RET quick-test RET it
takes me to config.el (a tangled file, suitable for computers, not
humans), rather than config.org.  Is it possible instead to get the
editor to jump to the definition in config.org?

Stephen

Re: Moving to a literate file for .emacs

[Immanuel Litzroth]

It's possible to let tangling generate comments that will link back to the
literate file where you defined the function.
https://orgmode.org/manual/Extracting-Source-Code.html
See the comment header arg.

Then you could advise the relevant functions that do emacs function lookup
to check whether there's such a "link comment" near the definition and jump
to that instead.

All this is rather hackish and I stopped doing my init files in literate org.
Immanuel

On Mon, Jul 4, 2022 at 4:07 PM Stephen Eglen <sje30@cam.ac.uk> wrote:
>
> I see many users are switching to using a 'literate programming'
> approach to tangling their .emacs file from an org file.
>
> Has anyone solved the following problem though?  If I have a file called
> config.org containing:
>
> * test
>
> #+begin_src emacs-lisp
>   (defun quick-test ()
>     "interactive"
>     (* 3 9)
>   )
> #+end_src
>
>
> and then in my .emacs file I do:
>
> (org-babel-load-file "~/config.org")
>
> quick-test is indeed defined, but when I do C-c f RET quick-test RET it
> takes me to config.el (a tangled file, suitable for computers, not
> humans), rather than config.org.  Is it possible instead to get the
> editor to jump to the definition in config.org?
>
> Stephen
>
>


-- 
-- A man must either resolve to point out nothing new or to become a
slave to defend it. -- Sir Isaac Newton

Re: Moving to a literate file for .emacs

[Samuel Banya]

[-- Attachment #1: Type: text/plain, Size: 1468 bytes --]

I have a literate Emacs config here that you can look at:
https://github.com/SamuelBanya/SamsEmacs/blob/main/configuration.org
https://github.com/SamuelBanya/SamsEmacs/blob/main/init.el

Take a look at the Emacs config links to other people's 'literate' Emacs configs, and you might get some ideas to steal from as well, look under 'Emacs Config Links (Custom User Configs, Emacs Distributions, etc.)':
https://apps.musimatic.xyz/webring.html

Also, Uncle Dave's Emacs YouTube tutorial is the best one for making an Emacs config based upon a 'config.org' file, would recommend this 100x:
https://www.youtube.com/playlist?list=PLX2044Ew-UVVv31a0-Qn3dA6Sd_-NyA1n

Hope this helps!

Sincerely,

Sam

On Mon, Jul 4, 2022, at 9:44 AM, Stephen Eglen wrote:
> I see many users are switching to using a 'literate programming'
> approach to tangling their .emacs file from an org file.
> 
> Has anyone solved the following problem though?  If I have a file called
> config.org containing:
> 
> * test
> 
> #+begin_src emacs-lisp
>   (defun quick-test ()
>     "interactive"
>     (* 3 9)
>   )
> #+end_src
> 
> 
> and then in my .emacs file I do:
> 
> (org-babel-load-file "~/config.org")
> 
> quick-test is indeed defined, but when I do C-c f RET quick-test RET it
> takes me to config.el (a tangled file, suitable for computers, not
> humans), rather than config.org.  Is it possible instead to get the
> editor to jump to the definition in config.org?
> 
> Stephen
> 
> 
> 

[-- Attachment #2: Type: text/html, Size: 2602 bytes --]