branch: elpa/hyperdrive
commit 7ecfc8e8c20512b7d684c6551faead9c46376e6f
Author: Joseph Turner <[email protected]>
Commit: Joseph Turner <[email protected]>
Docs: Update Troubleshooting section
---
doc/hyperdrive.org | 23 +++++++++++------------
doc/hyperdrive.texi | 33 +++++++++++++++++++++++----------
2 files changed, 34 insertions(+), 22 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 71af6491f3..621cb5b56a 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -1229,25 +1229,24 @@ to the relevant section in the ~hyperdrive.el~ manual.
* Troubleshooting
-If you run into issues, please first try resetting the values of
-~hyperdrive-hyperdrives~ and ~hyperdrive-version-ranges~:
+** Reinstall/upgrade the gateway
+
+Please ensure that you have the expected version of the gateway by
+running ~M-x hyperdrive-install~.
+
+** Reset bad persist variables
+
+It is possible that the persisted values of ~hyperdrive-hyperdrives~
+and/or ~hyperdrive-version-ranges~ are wrong. Reset them by evaluating:
#+begin_src emacs-lisp
(progn
- (setf hyperdrive-hyperdrives (make-hash-table :test #'equal))
+ (persist-reset 'hyperdrive-hyperdrives)
(persist-save 'hyperdrive-hyperdrives)
- (setf hyperdrive-version-ranges (make-hash-table :test #'equal))
+ (persist-reset 'hyperdrive-version-ranges)
(persist-save 'hyperdrive-version-ranges))
#+end_src
-# TODO: Update the next paragraph to mention install/upgrade command and omit
version numbers.
-
-Please ensure that your version of ~hyper-gateway-ushin~ (~M-x
-hyperdrive-gateway-version~) is version `3.8.0` ([download from
-Codeberg](https://codeberg.org/USHIN/hyper-gateway-ushin/releases/tag/v3.8.0)
-or [download from
-SourceHut](https://git.sr.ht/~ushin/hyper-gateway-ushin/refs/v3.8.0)).
-
* Contributing/Getting help
You're welcome to join our public XMPP chat room!
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index ec7c194f66..6b0399c188 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -171,6 +171,11 @@ Tips
* Quick documentation access::
+Troubleshooting
+
+* Reinstall/upgrade the gateway::
+* Reset bad persist variables::
+
Indices
* Keystroke index::
@@ -1670,23 +1675,31 @@ to the relevant section in the @code{hyperdrive.el}
manual.
@node Troubleshooting
@chapter Troubleshooting
-If you run into issues, please first try resetting the values of
-@code{hyperdrive-hyperdrives} and @code{hyperdrive-version-ranges}:
+@menu
+* Reinstall/upgrade the gateway::
+* Reset bad persist variables::
+@end menu
+
+@node Reinstall/upgrade the gateway
+@section Reinstall/upgrade the gateway
+
+Please ensure that you have the expected version of the gateway by
+running @code{M-x hyperdrive-install}.
+
+@node Reset bad persist variables
+@section Reset bad persist variables
+
+It is possible that the persisted values of @code{hyperdrive-hyperdrives}
+and/or @code{hyperdrive-version-ranges} are wrong. Reset them by evaluating:
@lisp
(progn
- (setf hyperdrive-hyperdrives (make-hash-table :test #'equal))
+ (persist-reset 'hyperdrive-hyperdrives)
(persist-save 'hyperdrive-hyperdrives)
- (setf hyperdrive-version-ranges (make-hash-table :test #'equal))
+ (persist-reset 'hyperdrive-version-ranges)
(persist-save 'hyperdrive-version-ranges))
@end lisp
-Please ensure that your version of @code{hyper-gateway-ushin} (@code{M-x
-hyperdrive-gateway-version}) is version `3.8.0` ([download from
-Codeberg](@uref{https://codeberg.org/USHIN/hyper-gateway-ushin/releases/tag/v3.8.0})
-or [download from
-SourceHut](@uref{https://git.sr.ht/~ushin/hyper-gateway-ushin/refs/v3.8.0})).
-
@node Contributing/Getting help
@chapter Contributing/Getting help
