branch: elpa/hyperdrive
commit 1a10c557e8639fc8b4d0a860f612b089a28adb4b
Author: Joseph Turner <jos...@ushin.org>
Commit: Joseph Turner <jos...@ushin.org>
Docs: (hyperdrive-mark-as-safe) Document hyperdrive safety
---
doc/hyperdrive.org | 24 ++++++++++++++++--------
doc/hyperdrive.texi | 27 +++++++++++++++++++--------
2 files changed, 35 insertions(+), 16 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 4cd10f8ceb..5a8e70ce05 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -319,15 +319,11 @@ default:
Jump to the parent hyperdrive directory from a hyperdrive file or
directory buffer. This command remaps the global ~dired-jump~ keybinding.
-The following customization options affect how files are displayed:
-
-- User Option: hyperdrive-safe-hyperdrives ::
+For security reasons, ~hyperdrive.el~ does not enable major modes based
+on file extension unless the hyperdrive has been marked as "safe" with
+~M-x hyperdrive-mark-as-safe~ (see [[*Mark a hyperdrive as safe]]).
- List of hyperdrive public keys to be considered safe. When a
- hyperdrive is considered safe, browsing files within it will cause a
- major code to automatically load, running code that could
- potentially cause harm on your system. Please be careful when
- adding a trusted public key to this list.
+The following customization options affect how files are displayed:
- User Option: hyperdrive-render-html ::
@@ -700,6 +696,18 @@ The following keybindings are available in
~hyperdrive-mirror-mode~:
Fold or unfold the section at point.
+** Mark a hyperdrive as safe
+
+For security reasons, ~hyperdrive.el~ does not enable major modes based
+on file extension unless the hyperdrive has been marked as "safe."
+
+- Command: hyperdrive-mark-as-safe ::
+
+ Mark a hyperdrive as "safe," which will cause major modes to be
+ automatically be enabled based on file extension when opening files
+ within that hyperdrive. Files in hyperdrives which are "not safe"
+ (the default) are opened in ~fundamental-mode~.
+
** Purge a hyperdrive
*Data which has been purged from your local machine may still be
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 8c8042be08..04d14fb3e0 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -91,6 +91,7 @@ Usage
* Stream audio and video::
* Download hyperdrive files::
* Upload files from your filesystem::
+* Mark a hyperdrive as safe::
* Purge a hyperdrive::
* Non-interactive use::
* Org-transclusion integration::
@@ -292,6 +293,7 @@ On the network it still may be there.
* Stream audio and video::
* Download hyperdrive files::
* Upload files from your filesystem::
+* Mark a hyperdrive as safe::
* Purge a hyperdrive::
* Non-interactive use::
* Org-transclusion integration::
@@ -564,15 +566,11 @@ Jump to the parent hyperdrive directory from a hyperdrive
file or
directory buffer. This command remaps the global @code{dired-jump} keybinding.
@end table
-The following customization options affect how files are displayed:
+For security reasons, @code{hyperdrive.el} does not enable major modes based
+on file extension unless the hyperdrive has been marked as ``safe'' with
+@code{M-x hyperdrive-mark-as-safe} (see @ref{Mark a hyperdrive as safe}).
-@defopt hyperdrive-safe-hyperdrives
-List of hyperdrive public keys to be considered safe. When a
-hyperdrive is considered safe, browsing files within it will cause a
-major code to automatically load, running code that could
-potentially cause harm on your system. Please be careful when
-adding a trusted public key to this list.
-@end defopt
+The following customization options affect how files are displayed:
@defopt hyperdrive-render-html
Control how HTML hyperdrive files are displayed. By default, HTML
@@ -1011,6 +1009,19 @@ Upload all of the files in the ``To Upload'' section.
Fold or unfold the section at point.
@end table
+@node Mark a hyperdrive as safe
+@section Mark a hyperdrive as safe
+
+For security reasons, @code{hyperdrive.el} does not enable major modes based
+on file extension unless the hyperdrive has been marked as ``safe.''
+
+@deffn Command hyperdrive-mark-as-safe
+Mark a hyperdrive as ``safe,'' which will cause major modes to be
+automatically be enabled based on file extension when opening files
+within that hyperdrive. Files in hyperdrives which are ``not safe''
+(the default) are opened in @code{fundamental-mode}.
+@end deffn
+
@node Purge a hyperdrive
@section Purge a hyperdrive
