refactor(lib): tidy doom-log output

This commit reduces the debug log noise, makes it easier to
read/parse/search, and soft-introduces a convention for doom-log
messages, where they are prefixed with a unique identifier loosely named
after it's running context or calling function.

I haven't enforced it everywhere doom-log is used yet, but this is a
start.
This commit is contained in:
Henrik Lissner 2022-09-11 20:12:22 +02:00
parent 0c43c769ef
commit 6cac7b05b6
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
8 changed files with 68 additions and 66 deletions

View file

@ -212,7 +212,7 @@ non-nil, treat FILES as pre-generated autoload files instead."
(dolist (file files (nreverse (delq nil autoloads)))
(when (and (not (seq-find (doom-rpartial #'string-match-p file) exclude))
(file-readable-p file))
(doom-log "Scanning %s" file)
(doom-log "loaddefs:scan: %s" file)
(setq file (file-truename file))
(with-temp-buffer
(if literal

View file

@ -125,8 +125,8 @@ Why this over exec-path-from-shell?
(pred (doom-rpartial #'string-match-p var)))
(when (seq-find pred denylist)
(if (seq-find pred allowlist)
(doom-log "Whitelisted %s" var)
(doom-log "Ignored %s" var)
(doom-log "cli:env: allow %s" var)
(doom-log "cli:env: deny %s" var)
(throw 'skip t)))
(insert (prin1-to-string env) "\n "))))
(insert ")"))

View file

@ -184,7 +184,7 @@ list remains lean."
;; `no-byte-compile'. Rebuilding unnecessarily is expensive.
(when (and (file-exists-p elc-file)
(file-newer-than-file-p file elc-file))
(doom-log "%s is newer than %s" file elc-file)
(doom-log "packages:elc: %s is newer than %s" file elc-file)
t)))
(defun doom-packages--eln-file-outdated-p (file)
@ -195,13 +195,15 @@ list remains lean."
(error-file (doom-packages--eln-error-file eln-name)))
(cond (eln-file
(when (file-newer-than-file-p file eln-file)
(doom-log "%s is newer than %s" file eln-file)
(doom-log "packages:eln: %s is newer than %s" file eln-file)
t))
((file-exists-p error-file)
(when (file-newer-than-file-p file error-file)
(doom-log "%s is newer than %s" file error-file)
(doom-log "packages:eln: %s is newer than %s" file error-file)
t))
((always (doom-log "%s doesn't exist" eln-name)))))))
((file-exists-p (byte-compile-dest-file file))
(doom-log "packages:eln: cannot find %s" eln-name)
t)))))
(defun doom-packages--native-compile-done-h (file)
"Callback fired when an item has finished async compilation."
@ -210,13 +212,13 @@ list remains lean."
(eln-file (doom-packages--eln-output-file eln-name))
(error-file (doom-packages--eln-error-file eln-name)))
(if (file-exists-p eln-file)
(doom-log "Compiled %s" eln-file)
(doom-log "packages:nativecomp: Compiled %s" eln-file)
(let ((error-dir (file-name-directory error-file)))
(if (not (file-writable-p error-dir))
(doom-log "Can't write %s" error-file)
(doom-log "packages:nativecomp: failed to write %s" error-file)
(make-directory error-dir 'parents)
(write-region "" nil error-file)
(doom-log "Wrote %s" error-file)))))))
(doom-log "packages:nativecomp: wrote %s" error-file)))))))
(defun doom-packages--wait-for-native-compile-jobs ()
"Wait for all pending async native compilation jobs."