[nongnu] elpa/hyperdrive 88948716a3 049/102: Docs: Document entry format defcustoms

[ELPA Syncer]

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

    Docs: Document entry format defcustoms
---
 doc/hyperdrive.org  | 17 +++++++++++++++++
 doc/hyperdrive.texi | 20 ++++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index d84022528d..640dc94f02 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -877,6 +877,23 @@ DIRECTION being one of ~:ascending~ or ~:descending~.
   version. To have separate buffers for each version of a
   file/directory, use ~same-version~.
 
+- ~hyperdrive-default-entry-format~ :: Format string for displaying
+  hyperdrive entries (files/directories).  By default, entries are
+  displayed with the default host format in brackets, followed by the
+  full entry path, followed by "version: " and version in parentheses.
+
+- ~hyperdrive-buffer-name-format~ :: Format string for buffer names of
+  buffers visiting hyperdrive files/directories.  By default, this
+  format is like ~hyperdrive-default-entry-format~ with the entry name
+  sans directory instead of the full path.
+
+- ~hyperdrive-format-alist~ :: Alist mapping hyperdrive and hyperdrive
+  entry metadata to a format string, used in
+  ~hyperdrive-default-entry-format~ and ~hyperdrive-buffer-name-format~ as
+  well as other places hyperdrives or entries are displayed.  By
+  default, each metadatum is prefixed by its type, e.g., the petname
+  ~foo~ is displayed by default as ~petname:foo~.
+
 ** Additional customization
 
 This section mentions ways to change the behavior of ~hyperdrive.el~
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 5b750f84d7..7605ecfa4c 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -1343,6 +1343,26 @@ By default (@code{any-version}), opening a hyperdrive 
file or directory
 reuses a buffer that is already visiting it, regardless of
 version. To have separate buffers for each version of a
 file/directory, use @code{same-version}.
+
+@item @code{hyperdrive-default-entry-format}
+Format string for displaying
+hyperdrive entries (files/directories).  By default, entries are
+displayed with the default host format in brackets, followed by the
+full entry path, followed by ``version: '' and version in parentheses.
+
+@item @code{hyperdrive-buffer-name-format}
+Format string for buffer names of
+buffers visiting hyperdrive files/directories.  By default, this
+format is like @code{hyperdrive-default-entry-format} with the entry name
+sans directory instead of the full path.
+
+@item @code{hyperdrive-format-alist}
+Alist mapping hyperdrive and hyperdrive
+entry metadata to a format string, used in
+@code{hyperdrive-default-entry-format} and 
@code{hyperdrive-buffer-name-format} as
+well as other places hyperdrives or entries are displayed.  By
+default, each metadatum is prefixed by its type, e.g., the petname
+@code{foo} is displayed by default as @code{petname:foo}.
 @end table
 
 @menu