[PATCH 5/5] prune-older: document current expectations

[Rob Browning]

Signed-off-by: Rob Browning <r...@defaultvalue.org>
Tested-by: Rob Browning <r...@defaultvalue.org>
---
Documentation/bup-prune-older.1.md | 6 ++++++
note/main.md | 4 ++++
2 files changed, 10 insertions(+)

diff --git a/Documentation/bup-prune-older.1.md b/Documentation/bup-prune-older.1.md
index 24e2eea8..ac4a6058 100644
--- a/Documentation/bup-prune-older.1.md
+++ b/Documentation/bup-prune-older.1.md
@@ -17,6 +17,12 @@ preserved by the various keep arguments detailed below. At least one
keep argument must be specified. This command is equivalent to a
suitable `bup rm` invocation followed by `bup gc`.

+Note that the current implementation expects a typical branch where a
+new save's date is always the same as or newer than the previous one.
+When that's not the case, only the saves at the end of the branch that
+have non-increasing timestamps (child to parent) will be affected by
+this command. Future versions are likely to lift this restriction.
+
WARNING: This is one of the few bup commands that modifies your
archive in intentionally destructive ways. Though if an attempt to
`join` or `restore` the data you still care about after a
diff --git a/note/main.md b/note/main.md
index 3d879486..5f9a88fe 100644
--- a/note/main.md
+++ b/note/main.md
@@ -30,6 +30,10 @@ May require attention
typically the case unless the system clock has been changed, or
commands like `bup get --pick` have been used.

+* `bup-prune-older`(1) now clarifies that the current implementation
+ expects every save in a branch to have a date that's newer than its
+ parent.
+
* The build system (e.g. `./configure`) no longer tries to find a
suitable make, and we no longer try to redirect a non-GNU make to
GNU make. Whatever make you invoke must be GNU make >= 4.2. On
--
2.47.3