Add a few minor doc and log improvements

0 views
Skip to first unread message

Rob Browning

unread,
Jul 7, 2026, 5:15:24 PM (9 days ago) Jul 7
to bup-...@googlegroups.com
Pushed to main.

--
Rob Browning
rlb @defaultvalue.org and @debian.org
GPG as of 2011-07-10 E6A9 DA3C C9FD 1FF8 C676 D2C4 C0F0 39E9 ED1B 597A
GPG as of 2002-11-03 14DD 432F AE39 534D B592 F9A0 25C8 D377 8C7E 73A4

Rob Browning

unread,
Jul 7, 2026, 5:15:25 PM (9 days ago) Jul 7
to bup-...@googlegroups.com
Signed-off-by: Rob Browning <r...@defaultvalue.org>
---
HACKING.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)

diff --git a/HACKING.md b/HACKING.md
index 4fb5198f..139ae01c 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -114,6 +114,26 @@ You may want to exclude test/tmp from backups because the testing
directories are preserved on failure (until the next `make clean`),
and test/tmp experiences a lot of churn.

+The tests are affected by a number of environment variables:
+
+ - `BUP_TEST_RANDOM_SEED=N`: sets the seed for the tests to `N`,
+ sometimes useful when trying to reproduce a failure.
+
+ - `BUP_TEST_LEVEL=N`: enables more tests when when set to 11 (`make
+ long-check does this`).
+
+ - `BUP_TEST_OTHER_BUP=PATH`: runs some tests comparing ./bup against
+ the bup executable indicated by `PATH`, e.g. an older version of
+ bup.
+
+ - `BUP_TEST_REMOTE_REPO=t`: runs real ssh remote tests; "ssh
+ localhost" must work without a password (e.g. via agent).
+
+ - `test_prune_older.py` responds to some `BUP_TEST_PRUNE_OLDER_...`
+ tuning parameters.
+
+Note that these variables may change in any given release.
+
Submitting patches
==================

--
2.47.3

Rob Browning

unread,
Jul 7, 2026, 5:15:25 PM (9 days ago) Jul 7
to bup-...@googlegroups.com
Signed-off-by: Rob Browning <r...@defaultvalue.org>
---
Documentation/bup-get.1.md | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/Documentation/bup-get.1.md b/Documentation/bup-get.1.md
index 824ea3c5..9fe317bd 100644
--- a/Documentation/bup-get.1.md
+++ b/Documentation/bup-get.1.md
@@ -144,12 +144,15 @@ used to help test before/after results.)
below). Currently, `--rewrite`, `---repair`, or `--copy` must be
specified whenever the source and destination repository
configurations differ in a relevant way, and so far, `--rewrite`
- is only supported for appends and picks. This option is also
- contextual (see CONTEXTUAL OPTIONS). Note that rewriting a
- git-created save may, and for now will, introduce bup-related
- changes. Further, while tested, `--rewrite` is relatively new and
- so warrants even more caution (see CAUTION above) than `bup get`
- itself. Please consider validating the results carefully for now.
+ is only supported for appends and picks of saves (e.g. not trees).
+
+ Note that rewriting a git-created save may, and for now will,
+ introduce bup-related changes. Further, while tested, `--rewrite`
+ is relatively new and so warrants even more caution (see CAUTION
+ above) than `bup get` itself. Please consider validating the
+ results carefully for now.
+
+ This option is contextual (see CONTEXTUAL OPTIONS).

\--repair
: in addition to what `--rewrite` does, perform all known repairs
--
2.47.3

Rob Browning

unread,
Jul 7, 2026, 5:15:25 PM (9 days ago) Jul 7
to bup-...@googlegroups.com
Signed-off-by: Rob Browning <r...@defaultvalue.org>
Tested-by: Rob Browning <r...@defaultvalue.org>
---
lib/bup/cmd/get.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/bup/cmd/get.py b/lib/bup/cmd/get.py
index eaec2c5a..6d489131 100644
--- a/lib/bup/cmd/get.py
+++ b/lib/bup/cmd/get.py
@@ -955,7 +955,7 @@ def get_everything(opt):

if repair_count and not saved_errors:
msg = ('Repairs were needed and successful; see above. Additional'
- ' information may be found in the git log. Search for '
+ ' information may be found in the git log. Search for'
' "Repair-ID:" in "git --git-dir REPO log ..." for the related'
' references.\n')
log(f'\n{fill(msg, width=tty_width(), break_on_hyphens=False)}\n')
--
2.47.3

Reply all
Reply to author
Forward
0 new messages