[elpa] externals/ebdb 4de630b 1/3: Add a manual section detailing how to disable EBDB in case of bug

[Eric Abrahamsen]

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

    Add a manual section detailing how to disable EBDB in case of bug
    
    * ebdb.org: How to kill it.
---
 ebdb.info | 133 ++++++++++++++++++++++++++++++++++----------------------------
 ebdb.org  |  15 +++++++
 ebdb.texi |  18 +++++++++
 3 files changed, 106 insertions(+), 60 deletions(-)

diff --git a/ebdb.info b/ebdb.info
index 9fbd5a8..cf55ae0 100644
--- a/ebdb.info
+++ b/ebdb.info
@@ -176,6 +176,19 @@ EBDB stores its records.
 Org and a number of mail user agents; see the following sections below
 for details.
 
+Emergency Escape Hatch
+     EBDB strives to be bug-free, naturally, but due to the nature of
+     the package, when bugs /do/ arise they can potentially interfere
+     with the reading and sending of email.  No one likes it when their
+     email is interfered with.  If, God forbid, you do encounter such a
+     bug, you can prevent it from doing harm by running:
+
+     (setq ebdb-mua-auto-update-p nil)
+
+   That will ensure that EBDB only runs when you explicitly command it
+to do so; it won’t interpose itself in other MUA operations.  If you
+really need to kill it and make it go away, use ‘M-x ebdb-shutdown’.
+
 * Menu:
 
 * Starting a New Database::
@@ -2651,66 +2664,66 @@ File: ebdb.info,  Node: Index,  Prev: Hacking EBDB,  
Up: Top
 Tag Table:
 Node: Top807
 Node: Getting Started2635
-Node: Starting a New Database3964
-Node: Migration from BBDB4788
-Node: Record Migration5031
-Node: Variables and Options5671
-Node: Migration from Org Contacts6158
-Node: The EBDB Database6918
-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 field20082
-Node: MUA Interaction20410
-Node: Loading MUA Code20963
-Node: Display and Updating21676
-Node: Pop-up Buffers22442
-Node: Auto-Updating Records24440
-Node: Noticing and Automatic Rules29234
-Node: Interactive Commands30567
-Node: EBDB and MUA summary buffers33041
-Node: Sender name display33559
-Node: Summary buffer marks34786
-Node: Mail Address Completion35965
-Node: A Note on Completion38474
-Node: Specific MUAs39097
-Node: Gnus39245
-Node: Posting Styles39467
-Node: EBDB Buffers41042
-Node: Searching42253
-Node: Changing Search Behavior43967
-Node: The Basics of ebdb-mode45214
-Node: Customizing Record Display49562
-Node: Marking53882
-Node: Exporting/Formatting54309
-Node: Completion55244
-Node: Snarfing56040
-Node: Internationalization58057
-Node: Diary Integration60758
-Node: Mail Aliases61623
-Node: vCard Support62337
-Node: Org Integration62836
-Node: Citing Records64734
-Node: Hacking EBDB65492
-Node: Field Classes68085
-Node: Init and Delete Methods71221
-Node: The Labeled Field Class72728
-Node: The Singleton Field Class73582
-Node: Actions74020
-Node: Custom Field Searching74692
-Node: Fast Lookups77559
-Node: Formatting in the EBDB Buffer79369
-Node: Writing Internationalization Libraries81445
-Node: Writing Integration For New MUAs85861
-Node: Article snarfing89309
-Node: Index90027
+Node: Starting a New Database4585
+Node: Migration from BBDB5409
+Node: Record Migration5652
+Node: Variables and Options6292
+Node: Migration from Org Contacts6779
+Node: The EBDB Database7539
+Node: Creating Records11730
+Node: Record classes12811
+Node: Record names13156
+Node: Record Fields13831
+Node: Inserting New Fields14075
+Node: Editing Existing Fields14871
+Node: Deleting Records and Fields15471
+Node: Field Types15867
+Node: Role fields18153
+Node: Tag field20134
+Node: Mail folder field20703
+Node: MUA Interaction21031
+Node: Loading MUA Code21584
+Node: Display and Updating22297
+Node: Pop-up Buffers23063
+Node: Auto-Updating Records25061
+Node: Noticing and Automatic Rules29855
+Node: Interactive Commands31188
+Node: EBDB and MUA summary buffers33662
+Node: Sender name display34180
+Node: Summary buffer marks35407
+Node: Mail Address Completion36586
+Node: A Note on Completion39095
+Node: Specific MUAs39718
+Node: Gnus39866
+Node: Posting Styles40088
+Node: EBDB Buffers41644
+Node: Searching42855
+Node: Changing Search Behavior44569
+Node: The Basics of ebdb-mode45816
+Node: Customizing Record Display50164
+Node: Marking54484
+Node: Exporting/Formatting54911
+Node: Completion55846
+Node: Snarfing56642
+Node: Internationalization58659
+Node: Diary Integration61360
+Node: Mail Aliases62225
+Node: vCard Support62939
+Node: Org Integration63438
+Node: Citing Records65336
+Node: Hacking EBDB66094
+Node: Field Classes68687
+Node: Init and Delete Methods71823
+Node: The Labeled Field Class73330
+Node: The Singleton Field Class74184
+Node: Actions74622
+Node: Custom Field Searching75294
+Node: Fast Lookups78161
+Node: Formatting in the EBDB Buffer79971
+Node: Writing Internationalization Libraries82047
+Node: Writing Integration For New MUAs86463
+Node: Article snarfing89911
+Node: Index90629
 
 End Tag Table
 
diff --git a/ebdb.org b/ebdb.org
index 1d744d1..6477405 100644
--- a/ebdb.org
+++ b/ebdb.org
@@ -54,6 +54,21 @@ EBDB comes with integration for a few other Emacs packages, 
including
 Org and a number of mail user agents; see the following sections below
 for details.
 
+- Emergency Escape Hatch :: EBDB strives to be bug-free, naturally,
+  but due to the nature of the package, when bugs /do/ arise they can
+  potentially interfere with the reading and sending of email.  No one
+  likes it when their email is interfered with.  If, God forbid, you
+  do encounter such a bug, you can prevent it from doing harm by
+  running:
+
+#+begin_src emacs-lisp
+  (setq ebdb-mua-auto-update-p nil)
+#+end_src
+
+  That will ensure that EBDB only runs when you explicitly command it
+  to do so; it won't interpose itself in other MUA operations.  If you
+  really need to kill it and make it go away, use ~M-x ebdb-shutdown~.
+
 ** Starting a New Database
 #+FINDEX: ebdb-open
 If you have no records you want to migrate from other contact
diff --git a/ebdb.texi b/ebdb.texi
index b4620be..c26194d 100644
--- a/ebdb.texi
+++ b/ebdb.texi
@@ -198,6 +198,24 @@ EBDB comes with integration for a few other Emacs 
packages, including
 Org and a number of mail user agents; see the following sections below
 for details.
 
+@table @asis
+@item Emergency Escape Hatch
+EBDB strives to be bug-free, naturally,
+but due to the nature of the package, when bugs /do/ arise they can
+potentially interfere with the reading and sending of email.  No one
+likes it when their email is interfered with.  If, God forbid, you
+do encounter such a bug, you can prevent it from doing harm by
+running:
+@end table
+
+@lisp
+(setq ebdb-mua-auto-update-p nil)
+@end lisp
+
+That will ensure that EBDB only runs when you explicitly command it
+to do so; it won't interpose itself in other MUA operations.  If you
+really need to kill it and make it go away, use @code{M-x ebdb-shutdown}.
+
 @menu
 * Starting a New Database::
 * Migration from BBDB::