NEWS

   1 NEWS for rsync 2.6.4 (UNRELEASED)
   2 Protocol: 29 (changed)
   3 Changes since 2.6.3:
   4
   5   OUTPUT CHANGES:
   6
   7     - When rsync deletes a directory and outputs a verbose message about
   8       it, it now appends a trailing slash to the name instead of (only
   9       sometimes) outputting a preceding "directory " string.
  10
  11     - The --stats output will contain file-list time-statistics if both
  12       sides are 2.6.4, or if the local side is 2.6.4 and the files are
  13       being pushed (since the stats come from the sending side).
  14       (Requires protocol 29 for a pull.)
  15
  16   BUG FIXES:
  17
  18     - Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
  19       was only treating it as a special token in an rsync include/exclude
  20       file).
  21
  22     - The combination of --verbose and --dry-run now mentions the full list
  23       of changes that would be output without --dry-run.
  24
  25     - Avoid a mkdir warning when removing a directory in the destination
  26       that already exists in the --backup-dir.
  27
  28     - An OS that has a binary mode for its files (such as cygwin0 needed
  29       setmode(fd, O_BINARY) called on the temp-file we opened with
  30       mkstemp().  (Fix derived from the Cygwin's 2.6.3 rsync package.)
  31
  32     - Fixed a potential hang when verbosity is high, the client side is
  33       the sender, and the file-list is large.
  34
  35     - We now check if the OS doesn't support using mknod() for creating
  36       FIFOs and sockets, and compile-in using mkfifo() and socket() when
  37       necessary.
  38
  39     - Fixed an off-by-one error in the handling of --max-delete=N.
  40
  41     - One place in the code wasn't checking if fork() failed.
  42
  43     - The "ignore nonreadable" daemon parameter used to erroneously affect
  44       symlinks that pointed to a non-existent file.  This has been fixed.
  45
  46     - If the OS does not have lchown() and its chown() tries to set the
  47       referent of a symlink (as it should), we no longer try to set the
  48       user and group of a symlink.
  49
  50     - The generator now properly runs the hard-link loop and the dir-time
  51       rewriting loop after we're sure that the redo phase is complete.
  52
  53     - When --backup was specified with --partial-dir=DIR (where DIR is a
  54       relative path), the backup code was erroneously trying to backup a
  55       file that was put into the partial-dir.
  56
  57     - One call to flush_write_file() was not being checked for an error.
  58
  59     - The --no-relative option was not being sent from the client to a
  60       server sender.
  61
  62     - If an rsync daemon specified "dont compress = ..." for a file and the
  63       client tried to specify --compress, the libz code was not handling a
  64       compression level of 0 properly.  This could cause a transfer failure
  65       if the block-size for a file was large enough (i.e. rsync might have
  66       exited with an error for large files).
  67
  68     - If a daemon can't open the specified log file (i.e. syslog is not
  69       being used), die without crashing.  We also output an error about
  70       the failure on stderr (which will only be seen if --no-detach was
  71       specified).
  72
  73     - A local transfer no longer duplicates all its include/exclude options
  74       (since the forked process already has a copy of the exclude list,
  75       there's no need to send them a set of duplicates).
  76
  77   ENHANCEMENTS:
  78
  79     - Rsync now supports popt's option aliases, which means that you can
  80       use /etc/popt and/or ~/.popt to create your own option aliases.
  81
  82     - Added the --delete-during (--del) option which will delete files
  83       from on the receiving side incrementally as each directory in the
  84       transfer is being processed.  This makes it more efficient than the
  85       default, before-the-transfer behavior, which is now available as
  86       --delete-before (this is the default --delete-WHEN option that will
  87       be chosen if --delete or --delete-excluded is specified without a
  88       --delete-WHEN choice).  All the --del* options infer --delete, so an
  89       rsync daemon that refuses "delete" will still refuse to allow any
  90       file-deleting options.
  91
  92     - All the --delete-WHEN options are now more memory efficient:
  93       Previously an entire duplicate set of file-list objects was created
  94       on the receiving side for the entire destination hierarchy.  The new
  95       algorithm only creates one directory of objects at a time.
  96
  97     - Added the --copy-dest option, which works like --link-dest except
  98       that it includes copies of identical files.
  99
 100     - Added support for specifying multiple --compare-dest, --copy-dest, or
 101       --link-dest options, but only of a single type. (Promoted from the
 102       patches dir and enhanced.)
 103
 104     - Added the --max-size option. (Promoted from the patches dir.)
 105
 106     - The daemon-mode options were separated from the normal rsync options
 107       so that they can't be mixed together.  This makes it impossible to
 108       start a daemon that had improper default option values that could
 109       cause problems (e.g. a hang or an abort) when a client connects.
 110
 111     - The --bwlimit option may now be used in combination with --daemon
 112       to specify both a default value for the daemon side and a value
 113       that cannot be exceeded by a user-specified --bwlimit option.
 114
 115     - Added the "port" parameter to the rsyncd.conf file. (Promoted from
 116       the patches dir.)  Also added "address".  A command-line option
 117       will take precedence over a config-file option, as expected.
 118
 119     - In _exit_cleanup(): when we are exiting with a partially-received
 120       file, we now flush any data in the write-cache before closing the
 121       partial file.
 122
 123     - The --inplace support was enhanced to work with --compare-dest,
 124       --link-dest, and (the new) --copy-dest options. (Requires protocol
 125       29.)
 126
 127     - Added the --dirs (-d) option for an easier way to copy directories
 128       without recursion.
 129
 130     - Added the --list-only option which is mainly a way for the client to
 131       put the server into listing mode without needing to resort to any
 132       internal option kluges (e.g. the age-old use of "-r --exclude="/*/*"
 133       for a non-recursive listing).  This option is used automatically
 134       (behind the scenes) when a modern rsync speaks to a modern daemon,
 135       but may also be specified manually if you want to force the use of
 136       the --list-only option over a remote-shell connection.
 137
 138     - Added the --omit-dir-times (-O) option which will avoid updating the
 139       modified time for directories when --times was specified.  This
 140       option will avoid an extra pass through the file-list at the end of
 141       the transfer (to tweak all the directory times), which can result in
 142       an appreciable speedup for a really large transfer. (Promoted from
 143       the patches dir.)
 144
 145     - Added the --filter (-f) option and its helper option, -F.  Filter
 146       rules are an extension to the existing include/exclude handling
 147       that also supports nested filter files as well as per-directory
 148       filter files (like .cvsignore, but with full filter-rule parsing).
 149       This new option was chosen in order to ensure that all existing
 150       include/exclude processing remained 100% compatible with older
 151       versions.  Protocol 29 is needed for full filter-rule support, but
 152       backward-compatible rules work with earlier protocol versions.
 153       (Promoted from the patches dir and enhanced.)
 154
 155     - Added the --delay-updates option that puts all updated files into
 156       a temporary directory (by default ".~tmp~", but settable via the
 157       --partial-dir=DIR option) until the end of the transfer.  This
 158       makes the updates a little more atomic for a large transfer.
 159
 160     - If rsync is put into the background, any output from --progress is
 161       reduced.
 162
 163     - Documented the "max verbosity" setting for rsyncd.conf.  (This
 164       setting was added a couple releases ago, but left undocumented.)
 165
 166     - The sender and the generator now double-check the file-list index
 167       they are given, and refuse to try to do a file transfer on a
 168       non-file index (since that would indicate that something had gone
 169       very wrong).
 170
 171     - Added the --itemize-changes (-i) option, which is a way to output a
 172       more detailed list of what files changed in any way and how they
 173       changed.  The effect is the same as specifying a --log-format of
 174       "%i %n%L" (see the rsyncd.conf manpage).  Works with --dry-run too.
 175
 176     - Added the --fuzzy option, which attempts to find a basis file for a
 177       file that is being created from scratch.  The current algorithm
 178       only looks in the destination directory for the created file, but
 179       it does attempt to find a match based on size/mod-time (in case the
 180       file was renamed with no other changes) as well as based on a fuzzy
 181       name-matching algorithm.  This option requires protocol 29 because
 182       it needs the new file-sorting order.  (Promoted from patches dir
 183       and enhanced.)
 184
 185     - Improved the option descriptions in the --help text.
 186
 187   SUPPORT FILES:
 188
 189     - Added atomic-rsync to the support dir: a perl script that will
 190       transfer some files using rsync, and then move the updated files into
 191       place all at once at the end of the transfer.  Only works when
 192       pulling, and uses --link-dest and a parallel hierarchy of files to
 193       effect its update.
 194
 195     - Added mnt-excl to the support dir: a perl script that takes the
 196       /proc/mounts file and translates it into a set of excludes that will
 197       exclude all mount points (even mapped mounts to the same disk).  The
 198       excludes are made relative to the specified source dir and properly
 199       anchored.
 200
 201     - Added savetransfer.c to the support dir: a C program that can make
 202       a copy of all the data that flows over the wire.  This lets you test
 203       for data corruption (by saving the data on both the sending side and
 204       the receiving side) or provides a way to help debug a protocol error.
 205
 206     - Added rrsync to the support dir: this is my version of Joe Smith's
 207       restricted rsync perl script.  This helps to ensure that only certain
 208       rsync commands can be run by an ssh invocation.
 209
 210   INTERNAL:
 211
 212     - Added better checking of the checksum-header values that come over
 213       the socket.
 214
 215     - Merged a variety of file-deleting functions into a single function so
 216       that it is easier to maintain.
 217
 218     - Improved the type of some variables (particularly blocksize vars) for
 219       consistency and proper size.
 220
 221     - Got rid of the uint64 type (which we didn't need).
 222
 223     - Use a slightly more compatible set of core #include directives.
 224
 225     - Defined int32 in a way that ensures that the build dies if we can't
 226       find a variable with at least 32 bits.
 227
 228     - The daemon's "read only" config item now sets an internal read_only
 229       variable that makes extra sure that no write/delete calls on the
 230       read-only side can succeed.
 231
 232   PROTOCOL DIFFERENCES FOR VERSION 29:
 233
 234     - A 16-bit flag-word is transmitted after every file-list index.  This
 235       indicates what is changing between the sender and the receiver.  The
 236       generator now transmits an index and a flag-word to indicate when
 237       dirs and symlinks have changed (resorting to the old-style outputting
 238       of local change-messages for older protocols).
 239
 240     - If --inplace is specified, the generator sends an extra byte after
 241       the flag-word indicating what kind of basis file is being used for
 242       the transfer (see the FNAMECMP_* defines).  This information is used
 243       to optimize the transfer when the basis file is not the destination.
 244
 245     - The sending of exclude names is done using filter-rule syntax.  This
 246       means that all names have a prefixed rule indicator, even excludes
 247       (which used to be sent as a bare pattern, when possible).  The -C
 248       option will include the per-dir .cvsignore merge file in the list of
 249       filter rules so it is positioned correctly (unlike in some older
 250       transfer scenarios).
 251
 252     - Rsync sorts the filename list in a different way: it sorts the subdir
 253       names after the non-subdir names for each dir's contents, and it
 254       always puts a dir's contents immediately after the dir's name in the
 255       list.  (Previously an item named "foo.txt" would sort in between
 256       directory "foo/" and "foo/bar".)
 257
 258     - When talking to a protocol 29 rsync daemon, a list-only request
 259       is able to note this before the options are sent over the wire, and
 260       the new --list-only option is encluded in the options sent over the
 261       socket.
 262
 263     - When the --stats bytes are sent over the wire (or stored in a batch),
 264       they now include two elapsed-time values: one for how long it took to
 265       build the file-list, and one for how long it took to send it over the
 266       wire (each expressed in thousandths of a second).
 267
 268     - When --delete-excluded is specified with some filter rules (AKA
 269       excludes), a client sender will now initiate a send of the filter
 270       rules to the receiver (older protocols used to omit the sending of
 271       excludes in this situation since there were no receiver-specific
 272       rules that survived --delete-excluded back then).  Note that, as with
 273       all the filter-list sending, only items that are significant to the
 274       other side will actually be sent over the wire, so the filter-rule
 275       list is often empty in this scenario.
 276
 277     - A protocol-29 batch file includes a bit for the setting of the --dirs
 278       option.  Also, the shell script created by --write-batch will use the
 279       --filter option instead of --exclude-from to capture any filter rules.
 280
 281   BUILD CHANGES:
 282
 283     - Handle an operating system that use mkdev() in place of makedev().
 284
 285     - Improved configure to better handle cross-compiling.