Rename bookmark_on_join to synchronise_open_rooms

Also add some more documentation about it.

5 files changed, 15 insertions, 9 deletions

diff --git a/data/default_config.cfg b/data/default_config.cfg
index aef4d62a..9f65f017 100644
--- a/data/default_config.cfg
+++ b/data/default_config.cfg
@@ -141,8 +141,8 @@ use_bookmarks_method =
 #open_all_bookmarks = false
 
 # Will create a bookmark on manual /join, using your preferred
-# storage method
-#bookmark_on_join = false
+# storage method. Use /leave to remove the bookmark.
+#synchronise_open_rooms = true
 
 # What will be put after the name, when using autocompletion at the
 # beginning of the input. A space will always be added after that
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index aceb6fb4..6af57ce7 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -371,12 +371,18 @@ to understand what is :ref:`carbons <carbons-details>` or
         sender intended it as such. See :ref:`Message Correction <correct-feature>` for
         more information.
 
-    bookmark_on_join
+    synchronise_open_rooms
 
-        **Default value:** ``false``
+        **Default value:** ``true``
+
+        If ``false``, poezio will not store the state of currently open rooms,
+        so that if you leave a room and restart poezio (or start another
+        client) it will reopen it.
+
+        If ``true``, ``/join`` will create a bookmark with ``autojoin=true``,
+        and ``/leave`` will remove said bookmark.
 
-        If ``true``, poezio will bookmark automatically every room that is joined with
-        a manual ``/join`` command.
+        This was previously named ``bookmark_on_join``.
 
     force_remote_bookmarks
 
diff --git a/poezio/config.py b/poezio/config.py
index 09d465cd..9a51e53f 100644
--- a/poezio/config.py
+++ b/poezio/config.py
@@ -38,7 +38,6 @@ DEFAULT_CONFIG = {
         'autorejoin_delay': '5',
         'autorejoin': False,
         'beep_on': 'highlight private invite disconnect',
-        'bookmark_on_join': False,
         'ca_cert_path': '',
         'certificate': '',
         'certfile': '',
@@ -133,6 +132,7 @@ DEFAULT_CONFIG = {
         'show_useless_separator': True,
         'status': '',
         'status_message': '',
+        'synchronise_open_rooms': True,
         'theme': 'default',
         'themes_dir': '',
         'tmp_image_dir': '',
diff --git a/poezio/core/commands.py b/poezio/core/commands.py
index 46dab5cc..176d0e73 100644
--- a/poezio/core/commands.py
+++ b/poezio/core/commands.py
@@ -401,7 +401,7 @@ class CommandCore:
                 tab.password = password
                 tab.join()
 
-        if config.get('bookmark_on_join'):
+        if config.get('synchronise_open_rooms'):
             method = 'remote' if config.get(
                 'use_remote_bookmarks') else 'local'
             self._add_bookmark('%s/%s' % (room, nick), True, password, method)
diff --git a/poezio/tabs/muctab.py b/poezio/tabs/muctab.py
index b37b725e..0df8eedc 100644
--- a/poezio/tabs/muctab.py
+++ b/poezio/tabs/muctab.py
@@ -1489,7 +1489,7 @@ class MucTab(ChatTab):
         /leave [msg]
         """
         self.leave_room(msg)
-        if config.get('bookmark_on_join'):
+        if config.get('synchronise_open_rooms'):
             self.core.bookmarks.remove(self.jid)
             self.core.bookmarks.save(self.core.xmpp)
         self.core.close_tab(self)