[nongnu] elpa/hyperdrive 8ea79f9aee 09/10: Docs: Comment out package-vc-installation instructions

[ELPA Syncer]

branch: elpa/hyperdrive
commit 8ea79f9aee75800edde2748646ec4445bdef2e60
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>

    Docs: Comment out package-vc-installation instructions
    
    package-vc-install has a bug related to building documentation that
    was patched after 29.1.
---
 doc/hyperdrive.org  | 67 ++++++++++++++++++++++++++++-------------------------
 doc/hyperdrive.texi | 53 ++++--------------------------------------
 2 files changed, 39 insertions(+), 81 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 4fd033f8bb..fccda8ba3a 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -59,8 +59,8 @@ hyper-gateway run --writable true
 
 ** hyperdrive.el
 
-There are three recommended options for installing ~hyperdrive.el~:
-NonGNU ELPA, MELPA, and ~package-vc~.
+The recommended options for installing ~hyperdrive.el~ are: NonGNU ELPA
+and MELPA.
 
 *** NonGNU ELPA
 
@@ -68,8 +68,8 @@ NonGNU ELPA, MELPA, and ~package-vc~.
 package-refresh-contents~ then ~M-x package-install RET hyperdrive~.
 
 After installing with NonGNU ELPA, you can later upgrade to a newer
-version of ~hyperdrive.el~ by running ~M-x package-refresh-contents~
-then ~M-x package-upgrade RET hyperdrive~. If ~package-upgrade~ is not
+version of ~hyperdrive.el~ by running ~M-x package-refresh-contents~ then
+~M-x package-upgrade RET hyperdrive~.  On Emacs 28, If ~package-upgrade~ is not
 available as a command, display the list of packages with ~M-x
 list-packages~, select ~hyperdrive~, and click the ~Install~ button.
 
@@ -85,43 +85,46 @@ repository...
 
 ...then follow the [[*NonGNU ELPA][NonGNU ELPA]] installation instructions.
 
-*** package-vc
 
-/package-vc only works on Emacs 29.2 or later./
+# TODO: Uncomment package-vc instructions when Emacs 29.2 is out
 
-1. Ensure you have ~git~, ~makeinfo~ (part of the ~texinfo~ package), and
-   Emacs 29.2 or newer.
+# *** package-vc
 
-2. Add the following lines to your ~init.el~ startup file:
+# /package-vc only works on Emacs 29.2 or later./
 
-#+begin_src emacs-lisp
-  (unless (package-installed-p 'hyperdrive)
-    ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as safe 
by default.
-    (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
-    (package-vc-install 'hyperdrive))
-#+end_src
+# 1. Ensure you have ~git~, ~makeinfo~ (part of the ~texinfo~ package), and
+#    Emacs 29.2 or newer.
 
-Alternatively, if you have already cloned the ~hyperdrive.el~ repository,
-you can use the following snippet to install from that repository:
+# 2. Add the following lines to your ~init.el~ startup file:
 
-#+begin_src emacs-lisp
-  (unless (package-installed-p 'hyperdrive)
-    (require 'package-vc)
-    ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as safe 
by default.
-    (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
-    ;; Change the path below to the location of your local hyperdrive.el 
repository.
-    (package-vc-install-from-checkout "~/.local/src/hyperdrive.el" 
"hyperdrive"))
-#+end_src
+# #+begin_src emacs-lisp
+#   (unless (package-installed-p 'hyperdrive)
+#     ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as 
safe by default.
+#     (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
+#     (package-vc-install 'hyperdrive))
+# #+end_src
+
+# Alternatively, if you have already cloned the ~hyperdrive.el~ repository,
+# you can use the following snippet to install from that repository:
+
+# #+begin_src emacs-lisp
+#   (unless (package-installed-p 'hyperdrive)
+#     (require 'package-vc)
+#     ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as 
safe by default.
+#     (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
+#     ;; Change the path below to the location of your local hyperdrive.el 
repository.
+#     (package-vc-install-from-checkout "~/.local/src/hyperdrive.el" 
"hyperdrive"))
+# #+end_src
 
-In your ~init.el~, type ~M-x eval-buffer RET~.
+# In your ~init.el~, type ~M-x eval-buffer RET~.
 
-If all goes well, ~hyperdrive.el~ commands like ~M-x hyperdrive-menu~ are
-now available and the documentation for ~hyperdrive.el~ is installed
-(see [[*Quick documentation access]]).
+# If all goes well, ~hyperdrive.el~ commands like ~M-x hyperdrive-menu~ are
+# now available and the documentation for ~hyperdrive.el~ is installed
+# (see [[*Quick documentation access]]).
 
-After installing with ~package-vc~, you can later upgrade to a newer
-version of ~hyperdrive.el~ by running ~M-x package-vc-upgrade RET
-hyperdrive RET~.
+# After installing with ~package-vc~, you can later upgrade to a newer
+# version of ~hyperdrive.el~ by running ~M-x package-vc-upgrade RET
+# hyperdrive RET~.
 
 * Example configuration
 
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 0a30c6fdb7..6a0d0170c3 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -76,7 +76,6 @@ hyperdrive.el
 
 * NonGNU ELPA::
 * MELPA::
-* package-vc::
 
 Usage
 
@@ -230,13 +229,12 @@ hyper-gateway run --writable true
 @node hyperdriveel
 @section hyperdrive.el
 
-There are three recommended options for installing @code{hyperdrive.el}:
-NonGNU ELPA, MELPA, and @code{package-vc}.
+The recommended options for installing @code{hyperdrive.el} are: NonGNU ELPA
+and MELPA@.
 
 @menu
 * NonGNU ELPA::
 * MELPA::
-* package-vc::
 @end menu
 
 @node NonGNU ELPA
@@ -246,8 +244,8 @@ NonGNU ELPA, MELPA, and @code{package-vc}.
 package-refresh-contents} then @code{M-x package-install RET hyperdrive}.
 
 After installing with NonGNU ELPA, you can later upgrade to a newer
-version of @code{hyperdrive.el} by running @code{M-x package-refresh-contents}
-then @code{M-x package-upgrade RET hyperdrive}. If @code{package-upgrade} is 
not
+version of @code{hyperdrive.el} by running @code{M-x package-refresh-contents} 
then
+@code{M-x package-upgrade RET hyperdrive}.  On Emacs 28, If 
@code{package-upgrade} is not
 available as a command, display the list of packages with @code{M-x
 list-packages}, select @code{hyperdrive}, and click the @code{Install} button.
 
@@ -264,49 +262,6 @@ repository@dots{}
 
 @dots{}then follow the @ref{NonGNU ELPA} installation instructions.
 
-@node package-vc
-@subsection package-vc
-
-@emph{package-vc only works on Emacs 29.2 or later.}
-
-@enumerate
-@item
-Ensure you have @code{git}, @code{makeinfo} (part of the @code{texinfo} 
package), and
-Emacs 29.2 or newer.
-
-@item
-Add the following lines to your @code{init.el} startup file:
-@end enumerate
-
-@lisp
-(unless (package-installed-p 'hyperdrive)
-  ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as safe by 
default.
-  (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
-  (package-vc-install 'hyperdrive))
-@end lisp
-
-Alternatively, if you have already cloned the @code{hyperdrive.el} repository,
-you can use the following snippet to install from that repository:
-
-@lisp
-(unless (package-installed-p 'hyperdrive)
-  (require 'package-vc)
-  ;; In Emacs 30, `ispell-buffer-session-localwords' will be marked as safe by 
default.
-  (put 'ispell-buffer-session-localwords 'safe-local-variable 
#'list-of-strings-p)
-  ;; Change the path below to the location of your local hyperdrive.el 
repository.
-  (package-vc-install-from-checkout "~/.local/src/hyperdrive.el" "hyperdrive"))
-@end lisp
-
-In your @code{init.el}, type @code{M-x eval-buffer RET}.
-
-If all goes well, @code{hyperdrive.el} commands like @code{M-x 
hyperdrive-menu} are
-now available and the documentation for @code{hyperdrive.el} is installed
-(see @ref{Quick documentation access}).
-
-After installing with @code{package-vc}, you can later upgrade to a newer
-version of @code{hyperdrive.el} by running @code{M-x package-vc-upgrade RET
-hyperdrive RET}.
-
 @node Example configuration
 @chapter Example configuration