branch: elpa/emacsql
commit b60d9e05e29aa2c05d341a10a0a4894c46a0c738
Author: Christopher Wellons <[email protected]>
Commit: Christopher Wellons <[email protected]>
Flesh out some docstrings.
---
emacsql-sqlite.el | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/emacsql-sqlite.el b/emacsql-sqlite.el
index 2d30d43fea..f3e19da768 100644
--- a/emacsql-sqlite.el
+++ b/emacsql-sqlite.el
@@ -87,6 +87,7 @@ buffer. This is for debugging purposes."
;; SQLite compilation
(defun emacsql-sqlite-compile-switches ()
+ "Return the compilation switches from the Makefile under sqlite/."
(let ((makefile (expand-file-name "sqlite/Makefile" emacsql-data-root))
(case-fold-search nil))
(with-temp-buffer
@@ -120,6 +121,8 @@ If called with non-nil ASYNC the return value is
meaningless."
(eql 0 (apply #'call-process cc nil (if async 0 t) t
arguments))))))))
+;; SQLite binary fetching
+
(defvar emacsql-sqlite-user-prompted nil
"To avoid prompting for fetch multiple times.")
@@ -157,6 +160,8 @@ This works like `url-copy-file' but actually checks for
errors."
(emacsql-sqlite-mark-exec emacsql-sqlite-executable)
:success)))))))
+;; Ensure the SQLite binary is available
+
(defun emacsql-sqlite-ensure-binary ()
"Ensure the EmacSQL SQLite binary is available, signaling an error if not."
(unless (file-exists-p emacsql-sqlite-executable)