branch: elpa/hyperdrive
commit 2f1aebbe04bab2c00a83ad95a52ba31ddd56fd35
Author: Joseph Turner <jos...@ushin.org>
Commit: Joseph Turner <jos...@ushin.org>
Docs: (hyperdrive-forget-file) Document command
---
doc/hyperdrive.org | 18 ++++++++++++++++++
doc/hyperdrive.texi | 22 ++++++++++++++++++++++
2 files changed, 40 insertions(+)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 260e172406..06419a74f3 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -267,6 +267,10 @@ available inside the directory view by default:
Delete the file or directory (recursively) at point.
+- Key: F (hyperdrive-forget-file) ::
+
+ Delete your local copy of the file for the current buffer.
+
- Key: H (hyperdrive-dir-history) ::
Open the version history (see [[*View the hyperdrive version history]])
@@ -457,6 +461,20 @@ version of the hyperdrive (see [[*View the hyperdrive
version history]]).*
This command also has a keybinding in the directory view (see
[[*Directory view]]).
+** Forget a hyperdrive file
+
+It is possible to "forget" your local copy of a hyperdrive file in
+order to save disk space. "Forgetting" a file does not delete the
+file from the hyperdrive and does not increment the hyperdrive's
+version number.
+
+- Command: hyperdrive-forget-file ::
+
+ Delete your local copy of the file for the current buffer.
+
+This command also has a keybinding in the directory view (see
+[[*Directory view]]).
+
** View the hyperdrive version history
Hyperdrives are versioned, meaning that you can explore the history of
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index ceba76ef70..4572a6e60b 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -84,6 +84,7 @@ Usage
* Write to a hyperdrive::
* Link to a hyperdrive::
* Delete a hyperdrive file::
+* Forget a hyperdrive file::
* View the hyperdrive version history::
* Describe a hyperdrive::
* Name a hyperdrive::
@@ -286,6 +287,7 @@ On the network it still may be there.
* Write to a hyperdrive::
* Link to a hyperdrive::
* Delete a hyperdrive file::
+* Forget a hyperdrive file::
* View the hyperdrive version history::
* Describe a hyperdrive::
* Name a hyperdrive::
@@ -502,6 +504,11 @@ Download the file at point to disk.
@findex hyperdrive-delete
Delete the file or directory (recursively) at point.
+@item @kbd{F} (@code{hyperdrive-forget-file})
+@kindex F
+@findex hyperdrive-forget-file
+Delete your local copy of the file for the current buffer.
+
@item @kbd{H} (@code{hyperdrive-dir-history})
@kindex H
@findex hyperdrive-dir-history
@@ -728,6 +735,21 @@ Delete the hyperdrive file in the current buffer.
This command also has a keybinding in the directory view (see
@ref{Directory view}).
+@node Forget a hyperdrive file
+@section Forget a hyperdrive file
+
+It is possible to ``forget'' your local copy of a hyperdrive file in
+order to save disk space. ``Forgetting'' a file does not delete the
+file from the hyperdrive and does not increment the hyperdrive's
+version number.
+
+@deffn Command hyperdrive-forget-file
+Delete your local copy of the file for the current buffer.
+@end deffn
+
+This command also has a keybinding in the directory view (see
+@ref{Directory view}).
+
@node View the hyperdrive version history
@section View the hyperdrive version history
