docs: refine wording/layout

This commit is contained in:
Zen Dodd committed 2026-10-10 19:29:14 +10:00
1 parent 1e61584e6d
commit 0b17f5fa5b
3 files changed
+7 -11

No files matched your search

+5 -5
View File
@@ -1,6 +1,8 @@
The script uses a temporary worktree, builds the requested tag, verifies the binary and removes the worktree.
# Old rsync versions
These statically linked binaries support cross-version regression checks and the version-mixing workflow. Peer expectations live in `testsuite/profiles/`.
These statically linked binaries support cross-version regression checks and the version-mixing workflow. Peer expectations live in `testsuite/profiles/`
Binary | Version | Protocol
--- | --- | ---
@@ -14,7 +16,7 @@ rsync_3.3.0 | 3.3.0 | 31
rsync_3.4.0 | 3.4.0 | 32
rsync_3.4.1 | 3.4.1 | 32
The archive starts at 2.6.0 because older releases require broader source changes to build with current toolchains.
The archive starts at 2.6.0 because older releases require broader source changes to build with modern toolchains.
## Rebuilding
```sh
@@ -22,6 +24,4 @@ The archive starts at 2.6.0 because older releases require broader source change
./build_static.sh 3.0.9 v3.0.9
```
Set `RSYNC_REPO` to override the source repository. The script uses a temporary worktree, builds the requested tag, verifies the binary and removes the worktree.
Compatibility patches cover old configure inputs, K&R prototypes, current libc declarations and compiler diagnostics. OpenSSL and `_FORTIFY_SOURCE` are disabled so the archived binaries retain their release-era checksum and memory behaviour when used as peers.
Set `RSYNC_REPO` to override the source repository. Compatibility patches cover old configure inputs, K&R prototypes, current libc declarations and compiler diagnostics. OpenSSL and `_FORTIFY_SOURCE` are disabled so the archived binaries retain their release-era checksum and memory behaviour when used as peers.
-2
View File
@@ -1,5 +1,3 @@
# Test coverage
Covered means a test directly checks the behaviour. Partial means the option is exercised without covering its whole contract. Missing identifies work still to do.
Path depth is deep, shallow, untested or N/A. Auxiliary tree is outside, inside only, untested or N/A depending on where the relevant backup, basis, partial or temporary tree is exercised.
+2 -4
View File
@@ -1,6 +1,6 @@
# rsync testsuite
Rsync's automated tests live here. Bug fixes should include a regression test when practical.
Rsync's automated tests live here. Bug fixes **should** include a regression test when practical.
## Layout
- `testsuite/tests/` groups test scripts by the subsystem they exercise
@@ -88,6 +88,4 @@ python3 -m testsuite.tools.compare_versions --sweep all -j5
python3 -m testsuite.tools.compare_versions --loop --timelimit 3600 --cost
```
The available transports are local copy, `support/lsh.sh`, a pipe daemon, a TCP daemon and rrsync. Pair each binary with the matching rrsync script when testing that transport.
Historical binaries live in `old_versions/`. Investigate differences and confirm the intended behaviour before adding a focused test under the relevant `testsuite/tests/` group.
The available transports are local copy, `support/lsh.sh`, a pipe daemon, a TCP daemon and rrsync. Pair each binary with the matching rrsync script when testing that transport. Historical binaries live in `old_versions/`. Investigate differences and confirm the intended behaviour before adding a focused test under the relevant `testsuite/tests/` group.