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