Merge branch 'mhop'

* mhop: (28 commits)
  runmirrors
  ftpsync, runmirrors
  runmirrors
  ftpsync
  runmirrors
  common
  runmirrors
  ftpsync tracefile
  fix whitespace indenting to minimize diff
  quote some more arguments
  fix whitespace to minimize diff between master and mhop branches
  readme
  More comments in the mirror sample
  common
  set delay to 600 to be what we tell users in our config file would be default
  runmirrors getopts
  common
  common
  runmirrors
  runmirrors
  ...

1 files changed, 24 insertions, 8 deletions

diff --git a/etc/runmirrors.mirror.sample b/etc/runmirrors.mirror.sample
index 2f841bb..744ad98 100644
--- a/etc/runmirrors.mirror.sample
+++ b/etc/runmirrors.mirror.sample
@@ -7,11 +7,15 @@
 #
 # Type ShortName HostName User -$SOMESSHOPTION
 #
+# The fields Type, ShortName, HostName and User are *mandantory*.
 #
-# Type is either all or staged, meaning:
+# Type is either all, staged or mhop, meaning:
 # all    - do a "normal" push. Trigger them, go on.
 # staged - do a two-stage push, waiting for them after stage 2(and all others that
 #          are staged) before doing stage2
+# mhop   - send a multi-hop staged push. This will tell the mirror to initiate
+#          a mhop/stage1 push to its staged/mhop mirrors and then exit.
+#          When all mhop got back we then send the stage2 through to them.
 #
 # ShortName will be used as a shorthand in logfile outputs and for the logfile
 # where every ssh output gets redirected to.
@@ -33,21 +37,33 @@
 # want. There is currently no way around this, as that would mean
 # dropping backward compatibility.
 #
+# Backwards compatibility:
+# An older runmirrors script will NOT run with a newer runmirrors.mirror file, but
+# a new runmirrors can run with an old runmirrors.mirror file. This should make updates
+# painless.
+#
 # Examples:
 # all eu.puccini puccini.debian.org archvsync 2
 #
-# will push puccini.debian.org, user archvsync, using ssh protocol 2 and the specified ssh key.
-#
+# -> will push puccini.debian.org, user archvsync, using ssh protocol 2
+#    and the globally configured ssh key.
 #
 # all eu.puccini puccini.debian.org archvsync -p 2222
 #
-# which will do the same as above, but use port 2222 to connect to.
+# -> will do the same as above, but use port 2222 to connect to.
+#
+# staged eu.puccini puccini.debian.org archvsync
+# staged eu.powell powell.debian.org archvsync
+#
+# -> will push both puccini and powell in stage1, waiting for both to
+#    finish stage1 before stage2 gets pushed. The username will be archvsync.
 #
-# staged eu.puccini puccini.debian.org
-# staged eu.powell powell.debian.org
+# staged eu.puccini puccini.debian.org archvsync
+# mhop eu.powell powell.debian.org archvsync
 #
-# will push both puccini and powell in stage1, waiting for both to
-# finish stage1 before stage2 gets pushed.
+# -> will do the same as above, but powell gets told about mhop and can then
+#    push its own staged/mhop mirrors before returning. When both returned
+#    then stage2 is sent to both.
 #
 # One special value is allowed: DELAY
 # This word has to be on a line itself, followed by a space and a number.