From 3ba61e7026d29bb6490b668a799b56c3161404d1 Mon Sep 17 00:00:00 2001
From: girst <girst@users.noreply.github.com>
Date: Tue, 29 Aug 2023 20:14:20 +0200
Subject: [PATCH] document BFcache workaround, webIsolationStrat bug

---
 documentation/known-bugs.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/documentation/known-bugs.md b/documentation/known-bugs.md
index 3b5211f..6ffda99 100644
--- a/documentation/known-bugs.md
+++ b/documentation/known-bugs.md
@@ -5,6 +5,27 @@ are some things that VimFx doesn't play along with well. This page lists
 problems that affect VimFx when run on versions of Firefox we support
 (latest *Release* and *ESR* versions).
 
+## BFcache
+
+**Affected**: Firefox >= 96  
+**Solution**: `fission.bfcacheInParent;false`
+
+VimFx is unloaded from tabs when the [bfcache] is handled in the parent
+process.
+
+The bfcache speeds up navigating back and forth through the browser history.
+Mozilla moved the location of this cache from the content process into the
+parent process. VimFx isn't properly restored when a page from this version of
+the cache is loaded. By setting `fission.bfcacheInParent` to `false` in
+`about:config` the cache can be bound to the content process again, avoiding
+the bug.
+
+<!-- Putting the bfcache into the parent process requires moving the data using
+IPC between processes. It is likely that the BootstrapLoader would need to be
+adapted to handle this, which is not happening unless someone else does it. -->
+
+[bfcache]: https://web.dev/bfcache/
+
 ## Fission
 
 **Affected**: Firefox >= 96  
@@ -21,12 +42,18 @@ iframe part of Fission, but is available only since Firefox 94. Some Nightly
 installations were opted into Fission earlier; set `fission.autostart`
 to `false` if the main workaround is unavailable.
 
+Note that as of now (Firefox 119), when `webContentIsolationStrategy` is set,
+reloading a webpage causes additional entries in the history and loss of forward
+history for the tab. This is tracked in [Bug 1832341]. To avoid this, disable
+Fission completely by setting `fission.autostart` to `false`.
+
 <!-- VimFx will probably never support Fission. Its architecture assumes that
 all elements can be interacted with from a single point. It would require
 revisiting 8a33140f and injecting a script into each frame and postMessage'ing
 them instead of directly accessing elements within them. -->
 
 [Fission]: https://wiki.mozilla.org/Project_Fission
+[Bug 1832341]: https://bugzilla.mozilla.org/show_bug.cgi?id=1832341
 
 ## VimFx behaves broken after installation
 
-- 
2.39.3