[elpa] externals/ebdb c5aac30 01/17: Change name of automatic save option

[Eric Abrahamsen]

branch: externals/ebdb
commit c5aac300f24f57482c54fcc861b60f2158888e4f
Author: Eric Abrahamsen <address@hidden>
Commit: Eric Abrahamsen <address@hidden>

    Change name of automatic save option
    
    * ebdb.el (ebdb-save-on-exit): Change from `ebdb-install-save-hook'.
      Use a name that says what it does, not how it does it.. This is a
      very new option, hopefully no one will notice the rename.
    * ebdb.org: Change docs.
    * ebdb.info: etc
    * ebdb.texi: etc
---
 ebdb.el   |   6 ++--
 ebdb.info | 109 +++++++++++++++++++++++++++++++-------------------------------
 ebdb.org  |   7 ++--
 ebdb.texi |   7 ++--
 4 files changed, 66 insertions(+), 63 deletions(-)

diff --git a/ebdb.el b/ebdb.el
index f32e436..5a94ce8 100644
--- a/ebdb.el
+++ b/ebdb.el
@@ -138,8 +138,8 @@ Future merging strategies may be smarter."
   :group 'ebdb-eieio
   :type 'boolean)
 
-(defcustom ebdb-install-save-hook t
-  "If non-nil, add `ebdb-save' to the hook `kill-emacs-hook'."
+(defcustom ebdb-save-on-exit t
+  "If non-nil, automatically save EBDB when exiting Emacs."
   :group 'ebdb-eieio
   :type 'boolean)
 
@@ -4969,7 +4969,7 @@ important work is done by the `ebdb-db-load' method."
     (run-hooks 'ebdb-after-load-hook)
     (when ebdb-use-diary
       (add-hook 'diary-list-entries-hook #'ebdb-diary-add-entries))
-    (when ebdb-install-save-hook
+    (when ebdb-save-on-exit
       (add-hook 'kill-emacs-hook #'ebdb-save))
     (length ebdb-record-tracker)))
 
diff --git a/ebdb.info b/ebdb.info
index 7b5539a..9090bc0 100644
--- a/ebdb.info
+++ b/ebdb.info
@@ -274,8 +274,9 @@ following keys can be used to manipulate databases and 
their records.
 
    Typically, databases are saved using the ‘s’ binding in ‘ebdb-mode’
 buffers, which runs ‘ebdb-save’.  By default, EBDB also installs
-‘ebdb-save’ as part of the ‘kill-emacs-hook’.  Set
-‘ebdb-install-save-hook’ to nil to prevent this.
+‘ebdb-save’ as part of the ‘kill-emacs-hook’, so that the EBDB is
+automatically saved before Emacs exit.  Set ‘ebdb-save-on-exit’ to nil
+to prevent this.
 
    Loading and initializing the EBDB can be slow for large databases.
 If you find yourself annoyed by the wait, try setting
@@ -1922,7 +1923,7 @@ Index
 * d e:                                   The EBDB Database.   (line  46)
 * d m:                                   The EBDB Database.   (line  57)
 * d r:                                   The EBDB Database.   (line  67)
-* Database load times:                   The EBDB Database.   (line  83)
+* Database load times:                   The EBDB Database.   (line  84)
 * Databases:                             The EBDB Database.   (line  11)
 * Deleting fields:                       Deleting Records and Fields.
                                                               (line   6)
@@ -2016,7 +2017,6 @@ Index
                                                               (line   6)
 * ebdb-insert-field <1>:                 The Basics of ebdb-mode.
                                                               (line  30)
-* ebdb-install-save-hook:                The EBDB Database.   (line  78)
 * ebdb-mail:                             The Basics of ebdb-mode.
                                                               (line  56)
 * ebdb-make-buffer-name:                 Writing Integration For New MUAs.
@@ -2089,6 +2089,7 @@ Index
 * ebdb-rename-buffer:                    EBDB Buffers.        (line  23)
 * ebdb-save:                             The Basics of ebdb-mode.
                                                               (line 108)
+* ebdb-save-on-exit:                     The EBDB Database.   (line  78)
 * ebdb-search-invert:                    Searching.           (line  49)
 * ebdb-search-pop:                       Searching.           (line  55)
 * ebdb-search-read:                      Custom Field Searching.
@@ -2101,7 +2102,7 @@ Index
 * ebdb-sources:                          The EBDB Database.   (line  11)
 * ebdb-toggle-records-format:            The Basics of ebdb-mode.
                                                               (line  61)
-* ebdb-try-speedups:                     The EBDB Database.   (line  83)
+* ebdb-try-speedups:                     The EBDB Database.   (line  84)
 * ebdb-use-diary:                        Diary Integration.   (line  13)
 * ebdb-user-name-address-re:             Auto-Updating Records.
                                                               (line  48)
@@ -2129,7 +2130,7 @@ Index
 * Internationalization:                  Internationalization.
                                                               (line   6)
 * Inverting searches:                    Searching.           (line  46)
-* Loading databases:                     The EBDB Database.   (line  83)
+* Loading databases:                     The EBDB Database.   (line  84)
 * m:                                     The Basics of ebdb-mode.
                                                               (line  56)
 * Mail aliases:                          Mail Aliases.        (line   6)
@@ -2188,54 +2189,54 @@ Node: Migration from BBDB3026
 Node: Record Migration3201
 Node: Variables and Options3921
 Node: The EBDB Database4407
-Node: Creating Records8341
-Node: Record classes9422
-Node: Record names9767
-Node: Record Fields10442
-Node: Inserting New Fields10686
-Node: Editing Existing Fields11482
-Node: Deleting Records and Fields12082
-Node: Field Types12478
-Node: Role fields14669
-Node: Tag field16357
-Node: Mail folder field17001
-Node: MUA Interaction17329
-Node: Loading MUA Code17853
-Node: Display and Updating18562
-Node: Pop-up Buffers19328
-Node: Auto-Updating Records20166
-Node: Noticing and Automatic Rules22566
-Node: Interactive Commands23899
-Node: EBDB and MUA summary buffers26261
-Node: Sender name display26747
-Node: Summary buffer marks27974
-Node: EBDB Buffers29153
-Node: Searching30335
-Node: Changing Search Behavior31997
-Node: The Basics of ebdb-mode33244
-Node: Marking36845
-Node: Exporting/Formatting37269
-Node: Completion38218
-Node: Snarfing39416
-Node: Internationalization41417
-Node: Diary Integration44116
-Node: Mail Aliases44981
-Node: vCard Support45695
-Node: Org Integration46194
-Node: Citing Records48092
-Node: Hacking EBDB48850
-Node: Field Classes51169
-Node: Init and Delete Methods54153
-Node: The Labeled Field Class55660
-Node: The Singleton Field Class56514
-Node: Actions56952
-Node: Custom Field Searching57624
-Node: Fast Lookups60428
-Node: Formatting in the EBDB Buffer62238
-Node: Writing Internationalization Libraries64251
-Node: Writing Integration For New MUAs68602
-Node: Article snarfing72021
-Node: Index72739
+Node: Creating Records8395
+Node: Record classes9476
+Node: Record names9821
+Node: Record Fields10496
+Node: Inserting New Fields10740
+Node: Editing Existing Fields11536
+Node: Deleting Records and Fields12136
+Node: Field Types12532
+Node: Role fields14723
+Node: Tag field16411
+Node: Mail folder field17055
+Node: MUA Interaction17383
+Node: Loading MUA Code17907
+Node: Display and Updating18616
+Node: Pop-up Buffers19382
+Node: Auto-Updating Records20220
+Node: Noticing and Automatic Rules22620
+Node: Interactive Commands23953
+Node: EBDB and MUA summary buffers26315
+Node: Sender name display26801
+Node: Summary buffer marks28028
+Node: EBDB Buffers29207
+Node: Searching30389
+Node: Changing Search Behavior32051
+Node: The Basics of ebdb-mode33298
+Node: Marking36899
+Node: Exporting/Formatting37323
+Node: Completion38272
+Node: Snarfing39470
+Node: Internationalization41471
+Node: Diary Integration44170
+Node: Mail Aliases45035
+Node: vCard Support45749
+Node: Org Integration46248
+Node: Citing Records48146
+Node: Hacking EBDB48904
+Node: Field Classes51223
+Node: Init and Delete Methods54207
+Node: The Labeled Field Class55714
+Node: The Singleton Field Class56568
+Node: Actions57006
+Node: Custom Field Searching57678
+Node: Fast Lookups60482
+Node: Formatting in the EBDB Buffer62292
+Node: Writing Internationalization Libraries64305
+Node: Writing Integration For New MUAs68656
+Node: Article snarfing72075
+Node: Index72793
 
 End Tag Table
 
diff --git a/ebdb.org b/ebdb.org
index 511dfcb..53e2f01 100644
--- a/ebdb.org
+++ b/ebdb.org
@@ -163,11 +163,12 @@ Other database-related commands:
      ~ebdb-reload-database~.
 
 #+CINDEX: Saving the database
-#+VINDEX: ebdb-install-save-hook
+#+VINDEX: ebdb-save-on-exit
 Typically, databases are saved using the {{{kbd(s)}}} binding in
 ~ebdb-mode~ buffers, which runs ~ebdb-save~.  By default, EBDB also
-installs ~ebdb-save~ as part of the ~kill-emacs-hook~.  Set
-~ebdb-install-save-hook~ to nil to prevent this.
+installs ~ebdb-save~ as part of the ~kill-emacs-hook~, so that the
+EBDB is automatically saved before Emacs exit.  Set
+~ebdb-save-on-exit~ to nil to prevent this.
 
 #+CINDEX: Loading databases
 #+CINDEX: Database load times
diff --git a/ebdb.texi b/ebdb.texi
index 0a80438..8a765be 100644
--- a/ebdb.texi
+++ b/ebdb.texi
@@ -307,11 +307,12 @@ a database, edit it using @code{ebdb-customize-database}, 
set
 @end table
 
 @cindex Saving the database
address@hidden ebdb-install-save-hook
address@hidden ebdb-save-on-exit
 Typically, databases are saved using the @kbd{s} binding in
 @code{ebdb-mode} buffers, which runs @code{ebdb-save}.  By default, EBDB also
-installs @code{ebdb-save} as part of the @code{kill-emacs-hook}.  Set
address@hidden to nil to prevent this.
+installs @code{ebdb-save} as part of the @code{kill-emacs-hook}, so that the
+EBDB is automatically saved before Emacs exit.  Set
address@hidden to nil to prevent this.
 
 @cindex Loading databases
 @cindex Database load times