Mention the addition of the deny-rsync script, and tweak some comments.

diff --git a/NEWS b/NEWS
index e6d1332..9497e0c 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -62,6 +62,12 @@ Changes since 3.0.2:
 
     - The description of the --inplace option was improved.
 
+  EXTRAS:
+
+    - Added a new script in the support directory, deny-rsync, which allows
+      an admin to (temporarily) replace the rsync command with a script that
+      sends an error message to the remote client via the rsync protocol.
+
   DEVELOPER RELATED:
 
     - Fixed a testcase failure if the tests are run as root and made some

diff --git a/support/deny-rsync b/support/deny-rsync
index 015b337..1993e3a 100755 (executable)
--- a/support/deny-rsync
+++ b/support/deny-rsync
@@ -18,19 +18,19 @@ if [ "${#msg}" -gt 254 ]; then
 fi
 msglen=$(( ${#msg} + 1 )) # add 1 for the newline we append below
 
-# send protocol version
+# Send protocol version.  All numbers are LSB-first 4-byte ints.
 echo -ne "$(byte_escape $protocol_version)\\000\\000\\000"
 
-# send checksum seed
+# Send a zero checksum seed.
 echo -ne "\\000\\000\\000\\000"
 
-# the following is equivalent to rwrite(FERROR, "$msg\n")
-# message header: length 17; MPLEX_BASE + code FERROR
+# The following is equivalent to rprintf(FERROR_XFER, "%s\n", $msg).
+# 1. Message header: ((MPLEX_BASE + FERROR_XFER) << 24) + $msglen.
 echo -ne "$(byte_escape $msglen)\\000\\000\\010"
-# data
+# 2. The actual data.
 echo -E "$msg"
 
-# make sure the client gets the message and not a write error
+# Make sure the client gets our message, not a write failure.
 sleep 1
 
 exit $exit_code