refine the documentation

doc/commands.rst

@@ -23,9 +23,10 @@ or:
 
 The available commands are:
 
-    :borg:       :ref:`run a raw borg command. <borg>`
-    :breaklock:  :ref:`breaks the repository and cache locks. <breaklock>`
+    :borg:       :ref:`run a raw borg command <borg>`
+    :breaklock:  :ref:`breaks the repository and cache locks <breaklock>`
     :check:      :ref:`checks the repository and its archives <check>`
+    :compact:    :ref:`compact segment files in the repository <compact>`
     :compare:    :ref:`compare local files with those in an archive <compare>`
     :configs:    :ref:`list available backup configurations <configs>`
     :create:     :ref:`create an archive of the current files <create>`
@@ -107,9 +108,28 @@ Check the integrity of the repository and its archives.  The most recently
 created archive is checked if one is not specified unless ``--all`` is given, in 
 which case all archives are checked.
 
-The ``--repair`` option will attempt to repair any damage found. Be aware that 
-this is considered an *experimental* feature in *Borg* and so carries extra risk 
-due to its immaturity.
+The ``--repair`` option attempts to repair any damage found. Be aware that this 
+is considered an *experimental* feature in *Borg* and so carries extra risk due 
+to its immaturity.
+
+
+.. _compact:
+
+Compact
+-------
+
+This command frees repository space by compacting segments.
+
+Use this regularly to avoid running out of space, however you do not need to it 
+after each *Borg* command. It is especially useful after deleting archives, 
+because only compaction really frees repository space.
+
+Requires Borg version 1.2 or newer.  Prior to version 1.2 the compact 
+functionality was part of the *Borg* *prune* command.  As of version 1.2 this 
+functionality was split into its own command.
+
+If you set :ref:`compact_after_delete` *Emborg* automatically runs this command 
+after every use of the :ref:`delete <delete>` and :ref:`prune <prune>` commands.
 
 
 .. _compare:

doc/configuring.rst

@@ -1163,6 +1163,15 @@ chunker_params
 Parameters used by the chunker command.
 
 
+.. _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/releases.rst

@@ -7,14 +7,11 @@ Latest development release
 | Released: 2022-03-13
 
 - Enhanced *Emborg* to support new Borg 1.2 features.
+
   - Added :ref:`compact command <compact>`
-  - Added
-    :ref:`chunker_params`,
-    :ref:`sparse`,
-    :ref:`sparse`,
-    :ref:`threshold`,
-    :ref:`upload_ratelimit`,
-    :ref:`upload_buffer` settings.
+  - Added :ref:`chunker_params`, :ref:`sparse`, :ref:`sparse`, :ref:`threshold`,
+    :ref:`upload_ratelimit`, :ref:`upload_buffer` settings.
+
 - Added the :ref:`run_before_borg and run_after_borg <run_before_borg>` 
   settings.
 - Added the ``--cache-only`` option and the ability to delete multiple archives 

emborg/command.py

@@ -420,9 +420,9 @@ class CompactCommand(Command):
         This command frees repository space by compacting segments.
 
         Use this regularly to avoid running out of space, however you do not
-        need to it after each after each Borg command. It is especially useful
-        after deleting archives, because only compaction will really free
-        repository space.
+        need to it after each Borg command. It is especially useful after
+        deleting archives, because only compaction will really free repository
+        space.
 
         Requires Borg version 1.2 or newer.
         """