[elpa] externals/ebdb 69bba67 1/4: Default ebdb-save-on-exit to nil

[Eric Abrahamsen]

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

    Default ebdb-save-on-exit to nil
    
    * ebdb.el (ebdb-save-on-exit): It's sort of redundant with
    `save-some-buffers', and can confuse users if they say "no" during the
    `save-some-buffers' prompt but then the database gets saved anyway.
    * ebdb.org (The EBDB Database): Mention all this in the manual.
---
 ebdb.el   |   8 +++-
 ebdb.info | 131 ++++++++++++++++++++++++++++++++------------------------------
 ebdb.org  |  11 ++++--
 ebdb.texi |  15 ++++---
 4 files changed, 89 insertions(+), 76 deletions(-)

diff --git a/ebdb.el b/ebdb.el
index 019b6cb..d597933 100644
--- a/ebdb.el
+++ b/ebdb.el
@@ -141,8 +141,12 @@ Future merging strategies may be smarter."
   :group 'ebdb-eieio
   :type 'boolean)
 
-(defcustom ebdb-save-on-exit t
-  "If non-nil, automatically save EBDB when exiting Emacs."
+(defcustom ebdb-save-on-exit nil
+  "If non-nil, automatically save EBDB when exiting Emacs.
+The user is always prompted to save the EBDB as part of the Emacs
+shutdown process anyway, reducing the usefulness of this option.
+If you're using EBDB without opening `ebdb-mode' buffers, you
+might consider setting it to t."
   :group 'ebdb-eieio
   :type 'boolean)
 
diff --git a/ebdb.info b/ebdb.info
index 8cdb0a6..b047f62 100644
--- a/ebdb.info
+++ b/ebdb.info
@@ -333,10 +333,13 @@ following keys can be used to manipulate databases and 
their records.
      to nil, and then reload it with ‘ebdb-reload-database’.
 
    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’, so that the EBDB is
-automatically saved before Emacs exit.  Set ‘ebdb-save-on-exit’ to nil
-to prevent this.
+buffers, which runs ‘ebdb-save’.  If you have open *EBDB* buffers and
+unsaved changes, you’ll also be prompted to save the database when
+running ‘save-some-buffers’.  If this isn’t enough, you can also set
+‘ebdb-save-on-exit’ to non-nil to have EBDB saved automatically (and
+silently) when killing Emacs.  Because killing Emacs already runs
+‘save-some-buffers’, this option is typically redundant and defaults to
+nil.
 
    Loading and initializing the EBDB can be slow for large databases.
 If you find yourself annoyed by the wait, try setting
@@ -1706,7 +1709,7 @@ radically changed by creating new classes, or overriding 
the existing
 methods of classes, without touching the original source code.  This
 manual won’t go into details about Emacs’ object-orientation support:
 see *note EIEIO: (eieio)Top. for information on defining classes, and
-*note Generic Functions: (elisp)Generic Functions. for information on
+*note Generic Functions: (elisp)Generic%20Functions. for information on
 writing generic functions and methods.
 
    Some information about EBDB’s various classes can had from Emacs’
@@ -2063,8 +2066,8 @@ File: ebdb.info,  Node: Writing Internationalization 
Libraries,  Next: Writing I
 ===========================================
 
 Writing new internationalization libraries involves using generic
-functions.  *note Generic Functions: (elisp)Generic Functions.  It will
-also require a bit of familiarity with EBDB’s internals.
+functions.  *note Generic Functions: (elisp)Generic%20Functions.  It
+will also require a bit of familiarity with EBDB’s internals.
 
    Internationalization affects three different field types: addresses,
 phone numbers, and names.  It works by providing “i18n” versions of
@@ -2302,7 +2305,7 @@ File: ebdb.info,  Node: Index,  Prev: Hacking EBDB,  Up: 
Top
 * 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  84)
+* Database load times:                   The EBDB Database.   (line  87)
 * Databases:                             The EBDB Database.   (line  11)
 * Deleting fields:                       Deleting Records and Fields.
                                                               (line   6)
@@ -2545,7 +2548,7 @@ File: ebdb.info,  Node: Index,  Prev: Hacking EBDB,  Up: 
Top
 * ebdb-sources:                          The EBDB Database.   (line  11)
 * ebdb-toggle-records-format:            The Basics of ebdb-mode.
                                                               (line  73)
-* ebdb-try-speedups:                     The EBDB Database.   (line  84)
+* ebdb-try-speedups:                     The EBDB Database.   (line  87)
 * ebdb-use-diary:                        Diary Integration.   (line  13)
 * ebdb-user-name-address-re:             Auto-Updating Records.
                                                               (line  66)
@@ -2577,7 +2580,7 @@ File: ebdb.info,  Node: Index,  Prev: Hacking EBDB,  Up: 
Top
 * Internationalization:                  Internationalization.
                                                               (line   6)
 * Inverting searches:                    Searching.           (line  48)
-* Loading databases:                     The EBDB Database.   (line  84)
+* Loading databases:                     The EBDB Database.   (line  87)
 * m:                                     The Basics of ebdb-mode.
                                                               (line  56)
 * M:                                     The Basics of ebdb-mode.
@@ -2643,60 +2646,60 @@ Node: Record Migration5031
 Node: Variables and Options5671
 Node: Migration from Org Contacts6158
 Node: The EBDB Database6918
-Node: Creating Records10906
-Node: Record classes11987
-Node: Record names12332
-Node: Record Fields13007
-Node: Inserting New Fields13251
-Node: Editing Existing Fields14047
-Node: Deleting Records and Fields14647
-Node: Field Types15043
-Node: Role fields17329
-Node: Tag field19310
-Node: Mail folder field19954
-Node: MUA Interaction20282
-Node: Loading MUA Code20835
-Node: Display and Updating21548
-Node: Pop-up Buffers22314
-Node: Auto-Updating Records24234
-Node: Noticing and Automatic Rules28640
-Node: Interactive Commands29973
-Node: EBDB and MUA summary buffers32447
-Node: Sender name display32965
-Node: Summary buffer marks34192
-Node: Mail Address Completion35371
-Node: A Note on Completion37880
-Node: Specific MUAs38503
-Node: Gnus38651
-Node: Posting Styles38873
-Node: EBDB Buffers40448
-Node: Searching41659
-Node: Changing Search Behavior43373
-Node: The Basics of ebdb-mode44620
-Node: Customizing Record Display48929
-Node: Marking53249
-Node: Exporting/Formatting53676
-Node: Completion54611
-Node: Snarfing55407
-Node: Internationalization57424
-Node: Diary Integration60125
-Node: Mail Aliases60990
-Node: vCard Support61704
-Node: Org Integration62203
-Node: Citing Records64101
-Node: Hacking EBDB64859
-Node: Field Classes67450
-Node: Init and Delete Methods70586
-Node: The Labeled Field Class72093
-Node: The Singleton Field Class72947
-Node: Actions73385
-Node: Custom Field Searching74057
-Node: Fast Lookups76924
-Node: Formatting in the EBDB Buffer78734
-Node: Writing Internationalization Libraries80810
-Node: Writing Integration For New MUAs85224
-Node: Article snarfing88672
-Node: Index89390
+Node: Creating Records11109
+Node: Record classes12190
+Node: Record names12535
+Node: Record Fields13210
+Node: Inserting New Fields13454
+Node: Editing Existing Fields14250
+Node: Deleting Records and Fields14850
+Node: Field Types15246
+Node: Role fields17532
+Node: Tag field19513
+Node: Mail folder field20157
+Node: MUA Interaction20485
+Node: Loading MUA Code21038
+Node: Display and Updating21751
+Node: Pop-up Buffers22517
+Node: Auto-Updating Records24437
+Node: Noticing and Automatic Rules28843
+Node: Interactive Commands30176
+Node: EBDB and MUA summary buffers32650
+Node: Sender name display33168
+Node: Summary buffer marks34395
+Node: Mail Address Completion35574
+Node: A Note on Completion38083
+Node: Specific MUAs38706
+Node: Gnus38854
+Node: Posting Styles39076
+Node: EBDB Buffers40651
+Node: Searching41862
+Node: Changing Search Behavior43576
+Node: The Basics of ebdb-mode44823
+Node: Customizing Record Display49132
+Node: Marking53452
+Node: Exporting/Formatting53879
+Node: Completion54814
+Node: Snarfing55610
+Node: Internationalization57627
+Node: Diary Integration60328
+Node: Mail Aliases61193
+Node: vCard Support61907
+Node: Org Integration62406
+Node: Citing Records64304
+Node: Hacking EBDB65062
+Node: Field Classes67655
+Node: Init and Delete Methods70791
+Node: The Labeled Field Class72298
+Node: The Singleton Field Class73152
+Node: Actions73590
+Node: Custom Field Searching74262
+Node: Fast Lookups77129
+Node: Formatting in the EBDB Buffer78939
+Node: Writing Internationalization Libraries81015
+Node: Writing Integration For New MUAs85431
+Node: Article snarfing88879
+Node: Index89597
 
 End Tag Table
 
diff --git a/ebdb.org b/ebdb.org
index 56a5226..65eec97 100644
--- a/ebdb.org
+++ b/ebdb.org
@@ -206,10 +206,13 @@ Other database-related commands:
 #+CINDEX: Saving the database
 #+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~, so that the
-EBDB is automatically saved before Emacs exit.  Set
-~ebdb-save-on-exit~ to nil to prevent this.
+~ebdb-mode~ buffers, which runs ~ebdb-save~.  If you have open
+{{{buf(EBDB)}}} buffers and unsaved changes, you'll also be prompted
+to save the database when running ~save-some-buffers~.  If this isn't
+enough, you can also set ~ebdb-save-on-exit~ to non-nil to have EBDB
+saved automatically (and silently) when killing Emacs. Because killing
+Emacs already runs ~save-some-buffers~, this option is typically
+redundant and defaults to nil.
 
 #+CINDEX: Loading databases
 #+CINDEX: Database load times
diff --git a/ebdb.texi b/ebdb.texi
index e1baf19..8817cb8 100644
--- a/ebdb.texi
+++ b/ebdb.texi
@@ -367,10 +367,13 @@ a database, edit it using @code{ebdb-customize-database}, 
set
 @cindex Saving the database
 @vindex 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}, so that the
-EBDB is automatically saved before Emacs exit.  Set
-@code{ebdb-save-on-exit} to nil to prevent this.
+@code{ebdb-mode} buffers, which runs @code{ebdb-save}.  If you have open
+*EBDB* buffers and unsaved changes, you'll also be prompted
+to save the database when running @code{save-some-buffers}.  If this isn't
+enough, you can also set @code{ebdb-save-on-exit} to non-nil to have EBDB
+saved automatically (and silently) when killing Emacs. Because killing
+Emacs already runs @code{save-some-buffers}, this option is typically
+redundant and defaults to nil.
 
 @cindex Loading databases
 @cindex Database load times
@@ -1857,7 +1860,7 @@ classes: database, record, and field.  The behavior of 
EBDB can be
 radically changed by creating new classes, or overriding the existing
 methods of classes, without touching the original source code.  This
 manual won't go into details about Emacs' object-orientation support:
-see @ref{Top,EIEIO,,eieio,} for information on defining classes, and 
@ref{Generic Functions,Generic Functions,,elisp,}
+see @ref{Top,EIEIO,,eieio,} for information on defining classes, and 
@ref{Generic%20Functions,Generic Functions,,elisp,}
 for information on writing generic functions and methods.
 
 Some information about EBDB's various classes can had from Emacs'
@@ -2231,7 +2234,7 @@ used in the body of the method.
 @section Writing Internationalization Libraries
 
 Writing new internationalization libraries involves using generic
-functions. @ref{Generic Functions,Generic Functions,,elisp,}.  It will also 
require a bit of
+functions. @ref{Generic%20Functions,Generic Functions,,elisp,}.  It will also 
require a bit of
 familiarity with EBDB's internals.
 
 Internationalization affects three different field types: addresses,