[nongnu] elpa/hyperdrive 2eb70dec5e 11/15: Docs: Improve documentation for creating drive and saving files

[ELPA Syncer]

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

    Docs: Improve documentation for creating drive and saving files
---
 doc/hyperdrive.org  | 43 +++++++++++++++++++++++++++++--------------
 doc/hyperdrive.texi | 42 ++++++++++++++++++++++++++++++------------
 2 files changed, 59 insertions(+), 26 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 9690970510..5c9ae8bd44 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -246,7 +246,8 @@ hyperdrives you've already created or visited:
 - Command: hyperdrive-find-file ::
 
   Open a hyperdrive file or directory by choosing one of your known
-  hyperdrives and a path inside it.
+  hyperdrives and a path inside it.  Like ~find-file~, this command can
+  be used to create a new file inside your own hyperdrives.
 
 - Command: hyperdrive-view-file ::
 
@@ -361,7 +362,6 @@ malformed public key, ~hyperdrive.el~ should ask you to 
double-check the
 URL.
 
 ** Create a hyperdrive
-#+findex: hyperdrive-new
 
 You can have multiple hyperdrives, each one containing its own set of
 files. Run ~M-x hyperdrive-new~ then type in a ~seed~ (see [[*Seeds]]) to
@@ -369,22 +369,37 @@ create a new hyperdrive. That seed will be combined with 
your secret
 master key (see [[*Master key]]) to produce a public key (see [[*Public
 keys]]) that uniquely identifies that hyperdrive.
 
+- Command: hyperdrive-new ::
+
+  Create a new hyperdrive from a seed string.
+
 ** Write to a hyperdrive
-#+findex: hyperdrive-write-buffer
-#+findex: save-buffer
-#+findex: save-some-buffers
 #+vindex: save-some-buffers-default-predicate
 
-You can write a buffer to a hyperdrive with ~hyperdrive-write-buffer~,
-which will prompt you for one of hyperdrives you have created as well
-as the path in that hyperdrive where you want to store the file. If
-you are editing an existing hyperdrive file, ~save-buffer~ will
-silently update the current hyperdrive file with the new content.
+After creating or opening a file in one of your hyperdrives,
+~save-buffer~ will silently update the current hyperdrive file with the
+new content.
+
+- Key: C-x C-s (save-buffer) ::
+
+  Save the current hyperdrive file buffer to its location.
+
+- Key: C-x s (save-some-buffers) ::
+
+  Save all modified hyperdrive file buffers to their locations.  This
+  command's primary purpose is to save normal file buffers, and
+  ~hyperdrive.el~ has integrated with it.
+
+  ~hyperdrive.el~ will prompt to save modified hyperdrive files before
+  exiting Emacs.  If you want the command ~save-some-buffers~ to always
+  prompt to save hyperdrive files in addition to regular files, set
+  ~save-some-buffers-default-predicate~ to ~t~.
+
+- Command: hyperdrive-write-buffer ::
 
-~hyperdrive.el~ will prompt to save modified hyperdrive files before
-exiting Emacs. If you want the command ~save-some-buffers~ to always
-prompt to save hyperdrive files in addition to regular files, set
-~save-some-buffers-default-predicate~ to ~t~.
+  Write the current buffer to a hyperdrive by choosing one of
+  hyperdrives you have created as well as the path in that hyperdrive
+  where you want to store the file.
 
 ** Link to a hyperdrive
 #+findex: hyperdrive-copy-url
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 836665baed..43544314bc 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -451,7 +451,8 @@ hyperdrives you've already created or visited:
 
 @deffn Command hyperdrive-find-file
 Open a hyperdrive file or directory by choosing one of your known
-hyperdrives and a path inside it.
+hyperdrives and a path inside it.  Like @code{find-file}, this command can
+be used to create a new file inside your own hyperdrives.
 @end deffn
 
 @deffn Command hyperdrive-view-file
@@ -608,31 +609,48 @@ URL@.
 @node Create a hyperdrive
 @section Create a hyperdrive
 
-@findex hyperdrive-new
-
 You can have multiple hyperdrives, each one containing its own set of
 files. Run @code{M-x hyperdrive-new} then type in a @code{seed} (see 
@ref{Seeds}) to
 create a new hyperdrive. That seed will be combined with your secret
 master key (see @ref{Master key}) to produce a public key (see @ref{Public 
keys}) that uniquely identifies that hyperdrive.
 
+@deffn Command hyperdrive-new
+Create a new hyperdrive from a seed string.
+@end deffn
+
 @node Write to a hyperdrive
 @section Write to a hyperdrive
 
-@findex hyperdrive-write-buffer
-@findex save-buffer
-@findex save-some-buffers
 @vindex save-some-buffers-default-predicate
 
-You can write a buffer to a hyperdrive with @code{hyperdrive-write-buffer},
-which will prompt you for one of hyperdrives you have created as well
-as the path in that hyperdrive where you want to store the file. If
-you are editing an existing hyperdrive file, @code{save-buffer} will
-silently update the current hyperdrive file with the new content.
+After creating or opening a file in one of your hyperdrives,
+@code{save-buffer} will silently update the current hyperdrive file with the
+new content.
+
+@table @asis
+@item @kbd{C-x C-s} (@code{save-buffer})
+@kindex C-x C-s
+@findex save-buffer
+Save the current hyperdrive file buffer to its location.
+
+@item @kbd{C-x s} (@code{save-some-buffers})
+@kindex C-x s
+@findex save-some-buffers
+Save all modified hyperdrive file buffers to their locations.  This
+command's primary purpose is to save normal file buffers, and
+@code{hyperdrive.el} has integrated with it.
 
 @code{hyperdrive.el} will prompt to save modified hyperdrive files before
-exiting Emacs. If you want the command @code{save-some-buffers} to always
+exiting Emacs.  If you want the command @code{save-some-buffers} to always
 prompt to save hyperdrive files in addition to regular files, set
 @code{save-some-buffers-default-predicate} to @code{t}.
+@end table
+
+@deffn Command hyperdrive-write-buffer
+Write the current buffer to a hyperdrive by choosing one of
+hyperdrives you have created as well as the path in that hyperdrive
+where you want to store the file.
+@end deffn
 
 @node Link to a hyperdrive
 @section Link to a hyperdrive