[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/sqlite3 d2b2032977 51/62: Update README.org
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/sqlite3 d2b2032977 51/62: Update README.org |
Date: |
Tue, 14 Mar 2023 11:01:48 -0400 (EDT) |
branch: elpa/sqlite3
commit d2b20329778af6544aaf914548bb333532fddc77
Author: Peking Duck <pekingduck@users.noreply.github.com>
Commit: Peking Duck <pekingduck@users.noreply.github.com>
Update README.org
Added unload instructions
---
README.org | 50 ++++++++++++++++++++++++++++----------------------
1 file changed, 28 insertions(+), 22 deletions(-)
diff --git a/README.org b/README.org
index aa10efbe4a..c4d62f3d7e 100644
--- a/README.org
+++ b/README.org
@@ -43,10 +43,12 @@
- [[#sqlite3-api-for-emacs-25][SQLite3 API for Emacs 25+]]
- [[#introduction][Introduction]]
- [[#requirements][Requirements]]
- - [[#installation][Installation]]
+ - [[#installation--removal][Installation & Removal]]
- [[#melpa][Melpa]]
- - [[#local-package][Local Package]]
- - [[#manual][Manual]]
+ - [[#elpa][Elpa]]
+ - [[#manual-installation][Manual Installation]]
+ - [[#removal][Removal]]
+ - [[#note-on-package-update][Note on Package Update]]
- [[#api][API]]
- [[#sqlite3-open][sqlite3-open]]
- [[#sqlite3-close][sqlite3-close]]
@@ -81,9 +83,9 @@
- A C99 compiler
It's been tested on macOS (Catalina) and CentOS 7.
-** Installation
+** Installation & Removal
*** Melpa
-You can now install the package via Melpa (package name: ~sqlite3~).
+The package is available on [[https://melpa.org/#/sqlite3][Melpa]] (thanks to
@tarsius).
The first time you ~(require 'sqlite3)~, you will be asked to confirm the
compilation of the dynamic module:
@@ -95,9 +97,7 @@ sqlite3-api module must be build. Do so now?
After the module is successfully compiled, you should ~(unload-feature
'sqlite3)~ and then ~(require sqlite3)~ to reload properly.
-You can ~(eval sqlite-ok)~ to test the installation. You should get a 0.
-
-*** Local Package
+*** Elpa
#+BEGIN_SRC sh :eval no :exports code
$ git co https://github.com/pekingduck/emacs-sqlite3-api
$ cd emacs-sqlite3-api
@@ -118,26 +118,32 @@ If you have sqlite3 installed in a nonstandard location:
$ make INC=/path/to/sqlite3/include LIB="-L/path/to/sqlite3/lib -lsqlite3"
#+END_SRC
-Currently there's no way to reload a dynamic module in Emacs
-(~unload-feature~ doesn't seem to work for dynamic modules.)
-If you are updating from an older version, you'll need to restart Emacs
-for the new module to take effect.
+*** Manual Installation
+#+BEGIN_SRC sh :eval no :exports code
+$ git co https://github.com/pekingduck/emacs-sqlite3-api
+$ cd emacs-sqlite3-api
+$ make
+$ cp sqlite3.el sqlite3-api.so /your/elisp/load-path/
+#+END_SRC
+
+*** Removal
+If you installed manually, just remove ~sqlite3.el~ and ~sqlite3-api.so~ from
+your load path. Otherwise, do ~M-x package-delete~ to remove the sqlite3
+package.
-2020-09-16 Update: I can't find it in ~etc/NEWS~, but it seems Emacs 27.1
-supports unloading of dynamic modules. To unload ~sqlite3~ properly:
+*** Note on Package Update
+Emacs 25 and 26: If you are updating from an older version, you'll need to
+restart Emacs for the new module to take effect. That's because
~unload-feature~
+doesn't work for dynamic modules.
+
+Emacs 27.1: I can't find it in
[[https://github.com/emacs-mirror/emacs/blob/emacs-27.1/etc/NEWS][~etc/NEWS~]],
but it seems Emacs 27.1
+does support unloading of dynamic modules. To unload ~sqlite3~ properly:
#+BEGIN_SRC emacs-lisp :eval no :exports code
(unload-feature 'sqlite3)
(unload-feature 'sqlite3-api)
#+END_SRC
-*** Manual
-#+BEGIN_SRC sh :eval no :exports code
-$ git co https://github.com/pekingduck/emacs-sqlite3-api
-$ cd emacs-sqlite3-api
-$ make
-$ cp sqlite3.el sqlite3-api.so /your/elisp/load-path/
-#+END_SRC
** API
To load the package, put the following in your ~.emacs~:
@@ -372,7 +378,7 @@ Currently two error symbols are defined in ~sqlite3.el~:
corresponding SQLite
C API.
-** A Note on Garbage Collection
+** Note on Garbage Collection
Since Emacs's garbage collection is non-deterministic, it would be
a good idea
to manually free database/statement handles once they are not needed.
- [nongnu] elpa/sqlite3 0dfe8e07df 30/62: 26.1 test added, (continued)
- [nongnu] elpa/sqlite3 0dfe8e07df 30/62: 26.1 test added, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 b8fc4e2fae 35/62: TOC, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 15697800f8 37/62: Fixed changelog, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 9a2dbb9dc2 38/62: fixed typo, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 f2c30e8b86 16/62: removed 'Package Version', ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 bdb5832e27 17/62: removed 'Package Version' from sqlite3-api-constants.el, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 639ffb711e 20/62: all .el files removed., ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 96e1cdfaa8 34/62: Rewrote README in org, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 33525c1976 29/62: Emacs 26.0-pretest test added, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 00f4591f25 36/62: Fixed TOC, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 d2b2032977 51/62: Update README.org,
ELPA Syncer <=
- [nongnu] elpa/sqlite3 b6868d2437 27/62: sqlite3-finalize accepts multiple params, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 a47384ef04 13/62: moved sqlite3-api-constants.el to tools/, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 b619a38eb5 25/62: fixed typos, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 781f915cd4 31/62: added sqlite3-fetch_alist, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 f702217d7b 32/62: Removed gcc warnings, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 e0943d0f90 39/62: Let users override make variables if necessary, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 e5b14b0318 46/62: Bump version to 0.14, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 d03bda0360 47/62: replaced == with eq in type predicates, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 75d89d64e6 49/62: Typo?, ELPA Syncer, 2023/03/14
- [nongnu] elpa/sqlite3 1caff0e721 52/62: Merge branch 'master' of github.com:pekingduck/emacs-sqlite3-api, ELPA Syncer, 2023/03/14