Răsfoiți Sursa

Mention deprecations

Updates #2943
JC Brand 4 luni în urmă
părinte
comite
333b4fa919
2 a modificat fișierele cu 24 adăugiri și 6 ștergeri
  1. 6 2
      Makefile
  2. 18 4
      docs/source/configuration.rst

+ 6 - 2
Makefile

@@ -267,10 +267,14 @@ docsdev: ./bin/activate requirements.txt
 .PHONY: html
 html: doc
 
-.PHONY: doc
-doc: node_modules docsdev
+.PHONY: sphinx
+sphinx: node_modules docsdev
 	rm -rf $(BUILDDIR)/html
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+.PHONY: doc
+doc:
+	make sphinx
 	make apidoc
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

+ 18 - 4
docs/source/configuration.rst

@@ -630,9 +630,16 @@ For example, if you want to prevent the chat history from getting too long or
 if you want to avoid gaps in the chat history (for example due to MAM not
 returning all messages since the last cached message).
 
-Beware, if you're using OMEMO, then you probably don't want to set this setting to
-``true``. OMEMO messages can be decrypted only once, so if they then
-subsequently get cleared, you won't get the plaintext back.
+.. note::
+    If you're using OMEMO, then you probably don't want to set this setting to
+    ``true``. OMEMO messages can be decrypted only once, so if they then
+    subsequently get cleared, you won't get the plaintext back.
+
+.. note::
+    This feature was implemented before we had list virtualization for the chat
+    history (release in version 11) and was largely a backstop until that
+    feature became available. This feature can therefore be considered
+    DEPRECATED and will likely be removed in future versions.
 
 
 chatstate_notification_blacklist
@@ -1250,7 +1257,14 @@ muc_clear_messages_on_leave
 
 Starting with Converse 8.0.0, when leaving a MUC, all cached messages in the history is cleared.
 
-Note: This means that you lose your history of decrypted OMEMO messages and cannot recover it.
+.. note::
+    This means that you lose your history of decrypted OMEMO messages and cannot recover it.
+
+.. note::
+    This feature was implemented before we had list virtualization for the chat
+    history (release in version 11) and was largely a backstop until that
+    feature became available. This feature can therefore be considered
+    DEPRECATED and will likely be removed in future versions.
 
 
 muc_disable_slash_commands