introduct assimilate

README.rst

@@ -8,7 +8,7 @@ Emborg — Front-End to Borg Backup
 :Released: 2024-11-11
 
 *Emborg* is a simple command line utility to orchestrate backups. It is built as 
-a front-end to Borg, a powerful and fast deduplicating backup program.  With 
+a front-end to Borg_, a powerful and fast deduplicating backup program.  With 
 *Emborg*, you specify all the details about your backups once in advance, and 
 then use a very simple command line interface for your day-to-day activities.  
 
@@ -17,13 +17,16 @@ repository.  The philosophy of *Emborg* is to provide commands that you would
 use often and in an interactive manner with the expectation that you would use 
 Borg directly for the remaining commands.
 
+*Emborg* is not intended for use with *Borg* version 2.0 or later.  Instead, the 
+successor to *Emborg* should be used: Assimilate_.
+
 
 Getting Help
 ------------
 
-You can find the documentation on `ReadTheDocs <https://emborg.readthedocs.io>`_.
+You can find the documentation here: Emborg_.
 
-The *help* command provides information on how to use Avendesora's various
+The *help* command provides information on how to use Emborg's various
 features.  To get a listing of the topics available, use::
 
     emborg help
@@ -36,6 +39,10 @@ It is worth browsing all of the available topics at least once to get a sense of
 all that *Emborg* can do.
 
 
+.. _borg: https://borgbackup.readthedocs.io
+.. _assimilate: https://assimilate.readthedocs.io
+.. _emborg: https://emborg.readthedocs.io
+
 .. |downloads| image:: https://pepy.tech/badge/emborg/month
     :target: https://pepy.tech/project/emborg
 

clean

@@ -3,7 +3,7 @@
 set nonomatch
 
 (cd tests && ./clean)
-rm -rf .mypy_cache .ruff_cache doc/.build
+rm -rf .mypy_cache .ruff_cache doc/.build .tox
 
 # the rest is common to all python directories
 rm -f *.pyc *.pyo */*.pyc */*.pyo .test*.sum expected result install.out

doc/index.rst

@@ -21,6 +21,24 @@ repository.  The philosophy of *Emborg* is to provide commands that you would
 use often and in an interactive manner with the expectation that you would use 
 *Borg* directly for more unusual or esoteric situations.
 
+.. important::
+
+    The *Borg* developers are currently working to release *Borg 2.0*, which is 
+    a substantial change from *Borg 1.4*.  *Borg 2.0* is a breaking change.  
+    Existing repositories must be transformed before they can be used with the 
+    new version, and the new version has a somewhat different and more powerful 
+    use model.  *Emborg* does not and will not support *Borg 2.0*.  Instead it 
+    being replaced by Assimilate_, which is the next generation of *Emborg*.  
+    Like *Borg 2*, *Assimilate* is a breaking change.  The format of the 
+    configuration files has changed and some of the settings have been renamed.  
+    Also, the more powerful use model of *Borg 2* is adopted.
+
+    *Emborg* will not support *Borg 2* and *Assimilate* will not support *Borg 
+    1*.  You should use *Emborg* until you are ready to transition to *Borg 2*, 
+    at which point you should also transition to *Assimilate*.
+
+    All future development is moving to *Assimilate* and *Emborg* is␣
+    transitioning to maintenance support only.
 
 Why Emborg?
 -----------
@@ -362,14 +380,15 @@ Contents
 
 * :ref:`genindex`
 
+.. _Assimilate: https://assimilate.readthedocs.io
+.. _Avendesora: https://avendesora.readthedocs.io
+.. _BorgBase: https://www.borgbase.com
 .. _Borg: https://borgbackup.readthedocs.io
 .. _BorgMatic: https://torsion.org/borgmatic
-.. _Vorta: https://github.com/borgbase/vorta
 .. _Duplicity: http://duplicity.nongnu.org
+.. _GitHub: https://github.com/KenKundert/emborg/issues
 .. _HealthChecks.io: https://healthchecks.io
-.. _SpareKeys: https://github.com/kalekundert/sparekeys
-.. _Avendesora: https://avendesora.readthedocs.io
-.. _RSync: https://www.rsync.net/products/attic.html
-.. _BorgBase: https://www.borgbase.com
 .. _Hetzner: https://www.hetzner.com/storage/storage-box
-.. _GitHub: https://github.com/KenKundert/emborg/issues
+.. _RSync: https://www.rsync.net/products/attic.html
+.. _SpareKeys: https://github.com/kalekundert/sparekeys
+.. _Vorta: https://github.com/borgbase/vorta