tweak the documentation

doc/configuring.rst

@@ -537,6 +537,23 @@ is not colored.  In general it is best to use the "light" colorscheme on dark
 backgrounds and the "dark" colorscheme on light backgrounds.
 
 
+.. _compact_after_delete:
+
+compact_after_delete
+~~~~~~~~~~~~~~~~~~~~
+
+If True, the :ref:`compact command <compact>` is run after deleting an archive 
+or pruning a repository.
+
+.. note::
+
+    This is an important setting if you are using *Borg 1.2* or later.  You 
+    should either set this true or manage the compaction in another way.  
+    Setting it true results in slightly slower backups.  The alternative is 
+    generally to configure *cron* or *anacron* to run the *compact* command 
+    routinely for you.
+
+
 .. _configurations:
 
 configurations
@@ -1206,15 +1223,6 @@ More information is available from `chunker_params Borg documentation
 <https://borgbackup.readthedocs.io/en/stable/usage/notes.html#chunker-params>`_.
 
 
-.. _compact_after_delete:
-
-compact_after_delete
-~~~~~~~~~~~~~~~~~~~~
-
-If True, the :ref:`compact command <compact>` is run after deleting an archive 
-or pruning a repository.
-
-
 .. _compression:
 
 compression

doc/installing.rst

@@ -120,6 +120,7 @@ The second file is the configuration file for *backups*:
 
     check_after_create = 'latest'
     prune_after_create = True
+    compact_after_delete = True
     keep_daily = 7
     keep_weekly = 4
     keep_monthly = 12
@@ -202,6 +203,7 @@ The third file is the configuration file for *snapshots*:
         **/.*.swp
     '''
     prune_after_create = True
+    compact_after_delete = True
     keep_within = '1d'
 
 In this case the repository is on the local machine and it is not encrypted. It 
@@ -240,8 +242,9 @@ using:
     $ emborg due
 
 However, you must remember to run this command. *Emborg* also provides 
-*emborg-overdue* to provide automated reminders.  You configure *emborg-overdue* 
-using a configuration file: ~/.config/emborg/overdue.conf.  For example:
+:ref:`emborg-overdue <emborg_overdue>` to provide automated reminders.  You 
+configure *emborg-overdue* using a configuration file: 
+~/.config/emborg/overdue.conf.  For example:
 
 .. code-block:: python
 
@@ -324,6 +327,7 @@ This assumes that most of the settings will be placed in *root*:
     '''
 
     check_after_create = 'latest'
+    compact_after_delete = True
     prune_after_create = True
     keep_daily = 7
     keep_weekly = 4

doc/monitoring.rst

@@ -5,6 +5,8 @@ Monitoring
 ==========
 
 
+.. _emborg_overdue:
+
 Overdue
 -------