[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/annotate 4e90910a2c 2/3: - updated version and documentati
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/annotate 4e90910a2c 2/3: - updated version and documentation. |
Date: |
Fri, 3 Jun 2022 06:58:01 -0400 (EDT) |
branch: elpa/annotate
commit 4e90910a2cc383446e610bfc4c110720ffbd70b5
Author: cage <cage@invalid>
Commit: cage <cage@invalid>
- updated version and documentation.
---
Changelog | 7 +++++++
NEWS.org | 8 +++++++-
README.org | 43 ++++++++++++++++++++++++++++++++++---------
annotate.el | 4 ++--
4 files changed, 50 insertions(+), 12 deletions(-)
diff --git a/Changelog b/Changelog
index 31112ee8b9..c43e997ebb 100644
--- a/Changelog
+++ b/Changelog
@@ -1,3 +1,10 @@
+2022-05-26 cage
+
+ * annotate.el:
+
+ - added procedures to generate and use a single database for each
+ annotated file.
+
2022-04-23 cage
* annotate.el:
diff --git a/NEWS.org b/NEWS.org
index 31dc2a76a6..9b453cf142 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -1,4 +1,10 @@
-- 2022-04-23 v1.5.4 cage::
+- 2022-05-26 v1.6.0 cage ::
+
+ This version allows users to instruct the program to generate an
+ annotation database for each annotated file, instead of using a
+ central database that contains all the annotations.
+
+- 2022-04-23 v1.5.4 cage ::
This version restored redrawing of annotation when the window is
resized.
diff --git a/README.org b/README.org
index 254bc9f4a0..707608b678 100644
--- a/README.org
+++ b/README.org
@@ -49,26 +49,51 @@ Please note that switching database, in this context,
means rebinding
the aforementioned variable (~annotate-file~). This means than no
more than a single database can be active for each Emacs session.
+If an empty annotation database (in memory) is saved the database
+file is deleted instead, if ~annotate-database-confirm-deletion~ is
+non nil (the default) a confirmation action is asked to the user
+before actually remove the file from the file system.
+
+**** related customizable variable
+ - ~annotate-file~
+ - ~annotate-warn-if-hash-mismatch~
+ - ~annotate-database-confirm-deletion~
+
+*** Non centralized database
+
To use multiple database in the same Emacs session ~annotate-file~ should be
made
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Buffer_002dLocal-Variables.html][buffer-local]],
see:
[[https://github.com/bastibe/annotate.el/issues/68][this thread]] and, in
particular
[[https://github.com/bastibe/annotate.el/issues/68#issuecomment-728218022][this
message]].
-If an empty annotation database (in memory) is saved the database
-file is deleted instead, if ~annotate-database-confirm-deletion~ is
-non nil (the default) a confirmation action is asked to the user
-before actually remove the file from the file system.
+Finally, if the customizable variable ~annotate-file-buffer-local~ is
+non-nil (default ~nil~), for each annotated file an annotation
+database is saved under the same directory that contains the annotated
+file.
+
+The name of the annotation database is built concatenating the name of
+the annotated file without the optional extension and the string value
+bound to the customizable variable
+~annotate-buffer-local-database-extension~ (default: ~notes~), example follows:
+
+| annotated file | annotations file |
+|------------------+----------------------|
+| /home/user/foo.c | /home/user/foo.notes |
+|------------------+----------------------|
+
+Important note: if ~/home/user/foo.notes~ exists, *will be overwritten*.
+
+**** related customizable variable
+ - ~annotate-file-buffer-local~
+ - ~annotate-buffer-local-database-extension~
+
+*** Uninstalling
Users of
[[https://github.com/emacscollective/no-littering][no-littering]]
can take advantage of its packages generated files management.
-**** related customizable variable
- - ~annotate-file~
- - ~annotate-warn-if-hash-mismatch~
- - ~annotate-database-confirm-deletion~
-
** keybindings
*** ~C-c C-a~ (function annotate-annotate)
diff --git a/annotate.el b/annotate.el
index c4e9fd8707..cf2059b14a 100644
--- a/annotate.el
+++ b/annotate.el
@@ -7,7 +7,7 @@
;; Maintainer: Bastian Bechtold <bastibe.dev@mailbox.org>, cage
<cage-dev@twistfold.it>
;; URL: https://github.com/bastibe/annotate.el
;; Created: 2015-06-10
-;; Version: 1.5.4
+;; Version: 1.6.0
;; This file is NOT part of GNU Emacs.
@@ -58,7 +58,7 @@
;;;###autoload
(defgroup annotate nil
"Annotate files without changing them."
- :version "1.5.4"
+ :version "1.6.0"
:group 'text)
(defvar annotate-mode-map