wgreenhouse
/
emacs-jabber
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Use literate-elisp instead of tangling

This commit is contained in:
contrapunctus 2021-03-18 20:26:45 +05:30
parent 02bf4d2378
commit de6dfefdfc
2 changed files with 13 additions and 13157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13150
jabber.el
View File

File diff suppressed because it is too large Load Diff

20
jabber.org
View File

@ -149,11 +149,13 @@ It is possible to make various web browsers pass links starting with "xmpp:" to
3. [ ] hexrgb.el is not available on MELPA
** About this file
jabber.el is an Org literate program.
jabber.el is an Org literate program. We use =literate-elisp= to directly load/compile this Org file. The former is exactly what the file =jabber.el= does - this approach is also compatible with =use-package= and others. The advantages -
1. links to the source (e.g. =describe-*= buffers, byte-compilation messages) take the user directly to the Org file rather than to the tangled source
2. no waiting for =org-babel-tangle= (which takes ages)
3. no need to track tangled files files in VCS, nor ensure they are kept in sync with the Org file
4. no VCS hooks/CI required to automatically tangle the file
=org-babel-tangle= takes ages, so we use a little sed one-liner (in the file-local variables) to do the tangling, which is nearly instant. The sed script emits anything between lines matching the exact strings "#+BEGIN_SRC emacs-lisp" and "#+END_SRC".
The sed script has the advantage that one can break a source block to insert Org commentary even within a =defun=, if desired - see =jabber-caps-ver-string= for a situation where such commentary may be desired. However, doing this may cause other tooling working on the s-expression level to break - =literate-elisp= definitely does.
Note that some tools, like =checkdoc=, still require a tangled file as of the time of this writing.
If a source block does not have syntax highlighting, press =M-o M-o= (=font-lock-fontify-block=) in it.
@ -210,6 +212,10 @@ If a source block does not have syntax highlighting, press =M-o M-o= (=font-lock
#+END_SRC
** Code
*** custom variables
#+BEGIN_SRC emacs-lisp
(defvar jabber-enable-legacy-features-p nil)
#+END_SRC
*** XML functions
:PROPERTIES:
:file: jabber-xml.el
@ -15242,6 +15248,7 @@ Return nil if no MD5 summing program is available."
*** SOCKS5 Bytestreams ([[https://xmpp.org/extensions/xep-0065.html][XEP-0065]])
:PROPERTIES:
:file: jabber-socks5.el
:header-args: :tangle jabber-socks5.el :load jabber-enable-legacy-features-p
:END:
#+BEGIN_SRC emacs-lisp
@ -16613,8 +16620,3 @@ Contents of process buffers might be useful for debugging."
;;; jabber.el ends here
#+END_SRC
** local variables
# Local Variables:
# eval: (progn (make-local-variable 'after-save-hook) (add-hook 'after-save-hook (lambda () (start-process-shell-command "jabber-sed-tangle" "jabber-sed-tangle" "sed -n -e '/#+BEGIN_SRC emacs-lisp$/,/#+END_SRC$/{//!p;}' jabber.org > jabber.el"))))
# End: