NEWS

   1 NEWS for rsync 3.0.0 (UNRELEASED)
   2 Protocol: 30 (changed)
   3 Changes since 2.6.9:
   4
   5   NOTABLE CHANGES IN BEHAVIOR:
   6
   7     - The handling of implied directories when using --relative has changed to
   8       send them as directories (e.g. no implied dir is ever sent as a symlink).
   9       This avoids unexpected behavior and should not adversely affect most
  10       people.  If you're one of those rare individuals who relied upon having
  11       an implied dir be duplicated as a symlink, you should specify the
  12       transfer of the symlink and the transfer of the referent directory as
  13       separate args.  (See also --keep-dirlinks and --no-implied-dirs.)
  14
  15     - Requesting a remote file list without specifying -r (--recursive) now
  16       sends the -d (--dirs) option to the remote rsync rather than sending -r
  17       along with an extra exclude of /*/*.  If the remote rsync does not
  18       understand the -d option (i.e. it is 2.6.3 or older), you will need to
  19       either turn off -d (--no-d), or specify  -r --exclude='/*/*'  manually.
  20
  21     - In --dry-run mode, the last line of the verbose summary text is output
  22       with a "(DRY RUN)" suffix to help remind you that no updates were made.
  23
  24     - A writable rsync daemon that disables "use chroot" now defaults to a
  25       symlink-munging behavior designed to make symlinks safer while also
  26       allowing absolute symlinks to be stored and retrieved.  This also has
  27       the effect of making symlinks unusable while they're in the daemon's
  28       hierarchy.  See the daemon option "munge symlinks" for full details.
  29
  30   BUG FIXES:
  31
  32     - Fixed the output of -ii when combined with one of the --*-dest options:
  33       it now itemizes all the items, not just the changed ones.
  34
  35     - Made the output of all file types consistent when using a --*-dest
  36       option.  Prior versions would output too many creation events for
  37       matching items.
  38
  39     - The code that waits for a child pid now handles being interrupted by a
  40       signal.  This fixes a problem with the pre-xfer exec function not being
  41       able to get the exit status from the script.
  42
  43     - A negated filter rule (i.e. with a '!' modifier) no longer loses the
  44       negation when sending the filter rules to the remote rsync.
  45
  46     - Fixed a problem with the --out-format (aka --log-format) option %f:  it
  47       no longer outputs superfluous directory info for a non-daemon rsync.
  48
  49     - Fixed a problem with -vv (double --verbose) and --stats when "pushing"
  50       files (which includes local copies).  Version 2.6.9 would complete the
  51       copy, but exit with an error when the receiver output its memory stats.
  52
  53     - If --password-file is used on a non-daemon transfer, rsync now complains
  54       and exits.  This should help users figure out that they can't use this
  55       option to control a remote shell's password prompt.
  56
  57     - Make sure that directory permissions of a newly-created destination
  58       directory are handled right when --perms is left off.
  59
  60     - The itemized output of a newly-created destination directory is now
  61       output as a creation event, not a change event.
  62
  63     - Improved --hard-link so that more corner cases are handled correctly
  64       when combined with options such as --link-dest and/or --ignore-existing.
  65
  66     - The --append option no longer updates a file that has the same size.
  67
  68     - Fixed a bug when combining --backup and --backup-dir with --inplace:
  69       any missing backup directories are now created.
  70
  71     - Fixed a bug when using --backup and --inplace with --whole-file or
  72       --read-batch: backup files are actually created now.
  73
  74     - Starting up an extra copy of an rsync daemon will not clobber the pidfile
  75       for the running daemon -- if the pidfile exists, the new daemon will exit
  76       with an error.
  77
  78     - The daemon pidfile is checked and created sooner in the startup sequence.
  79
  80     - If a daemon module's "path" value is not an absolute pathname, the code
  81       now makes it absolute internally (making it work properly).
  82
  83     - Ensure that a temporary file always has owner-write permission while we
  84       are writing to it.  This avoids problems with some network filesystems.
  85
  86     - Any errors output about password-file reading no longer cause an error at
  87       the end of the run about a partial transfer.
  88
  89     - Using --only-write-batch to a daemon receiver now work properly (older
  90       versions would update some files while writing the batch).
  91
  92   ENHANCEMENTS:
  93
  94     - A new incremental-recursion algorithm is now used when rsync is talking
  95       to another 3.x version.  This starts the transfer going more quickly
  96       (before all the files have been found), and requires much less memory.
  97       See the --recursive option in the manpage for some restrictions.
  98
  99     - Lowered memory use in the non-incremental-recursion algorithm for typical
 100       option values (usually saving from 21-29 bytes per file).
 101
 102     - The default --delete algorithm is now --delete-during when talking to a
 103       3.x rsync.  This is a faster scan than using --delete-before (which is
 104       the default when talking to older rsync versions), and is compatible with
 105       the new incremental recursion mode.
 106
 107     - Rsync now allows multiple remote-source args to be specified rather than
 108       having to rely on a special space-splitting side-effect of the remote-
 109       shell.  Additional remote args must specify the same host or an empty one
 110       (e.g. empty:  :file1  or  ::module/file2).  This means that local use of
 111       brace expansion now works:  rsync -av host:dir/{f1,f2} .
 112
 113     - Added the --protect-args (-s) option, that tells rsync to send most of
 114       the command-line args at the start of the transfer rather than as args
 115       to the remote-shell command.  This protects them from space-splitting,
 116       and only interprets basic wildcard special shell characters (*?[).
 117
 118     - Added the --delete-delay option, which is a more efficient way to delete
 119       files at the end of the transfer without needing a separate delete pass.
 120
 121     - Added the --acls (-A) option to preserve Access Control Lists.  This is
 122       an improved version of the prior patch that was available, and it even
 123       supports OS X ACLs.  If you need to have backward compatibility with old,
 124       acl-patched versions of rsync, apply the acls.diff file from the patches
 125       dir.
 126
 127     - Added the --xattrs (-X) option to preserver extended attributes.  This is
 128       an improved version of the prior patch that was available, and it even
 129       supports OS X xattrs (which includes their resource fork data).  If you
 130       need to have backward compatibility with old, xattr-patched versions of
 131       rsync, apply the xattrs.diff file from the patches dir.
 132
 133     - Added the --fake-super option that allows a non-super user to preserve
 134       all attributes of a file by using a special extended-attribute idiom.
 135       It even supports the storing of foreign ACL data on your backup server.
 136       There is also an analogous "fake super" option for an rsync daemon.
 137
 138     - Added the --iconv option, which allows rsync to convert filenames from
 139       one character-set to another during the transfer.  The default is to make
 140       this feature available as long as your system has iconv_open().  If
 141       compilation fails, specify --disable-iconv to configure, and then
 142       rebuild.  If you want rsync to perform character-set conversions by
 143       default, you can specify --enable-iconv=CONVERT_STRING with the default
 144       value for the --iconv option that you wish to use.  For example,
 145       "--enable-iconv=." is a good choice.  See the rsync manpage for an
 146       explanation of the --iconv option's settings.
 147
 148     - Added the --skip-compress=LIST option to override the default list of
 149       file suffixes that will not be compressed when using --compress.
 150
 151     - The daemon's default for "dont compress" was extended to include:
 152           *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
 153       The matching routine was also optimized to run more quickly.
 154
 155     - The --max-delete option now outputs a warning if it skipped any file
 156       deletions, including a count of how many deletions were skipped.  (Older
 157       versions just silently stopped deleting things.)
 158
 159     - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
 160       about extraneous files without deleting anything.  If you're not sure
 161       what version the client is, you can use the less-obvious --max-delete=-1,
 162       as both old and new versions will treat that as the same request (though
 163       older versions don't warn).
 164
 165     - The --hard-link option now uses less memory on both the sending and
 166       receiving side for all protocol versions.  For protocol 30, the use of a
 167       hashtable on the sending side allows us to more efficiently convey to the
 168       receiver what files are linked together.  This reduces the amount of data
 169       sent over the socket by a considerable margin (rather than adding more
 170       data), and limits the in-memory storage of the device+inode information
 171       to just the sending side for the new protocol 30, or to the receiving
 172       side when speaking an older protocol (note that older rsync versions kept
 173       the device+inode information on both sides).
 174
 175     - The filter rules now support a perishable ("p") modifier that marks rules
 176       that should not have an effect in a directory that is being deleted.  e.g.
 177       -f '-p .svn/' would only affect "live" .svn directories.
 178
 179     - If we get an error setting the time on a symlink, we don't complain about
 180       it anymore (since some operating systems don't support that, and it's not
 181       that important).
 182
 183     - Protocol 30 now uses MD5 checksums instead of MD4.
 184
 185     - Changed the --append option to not checksum the existing data in the
 186       destination file, which speeds up file appending.
 187
 188     - Added the --append-verify option, which works like the older --append
 189       option (verifying the existing data in the destination file).  For
 190       compatibility with older rsync versions, any use of --append that is
 191       talking protocol 29 or older will revert to the --append-verify method.
 192
 193     - Added the --contimeout=SECONDS option that lets the user specify a
 194       connection timeout for rsync daemon access.
 195
 196     - Documented and extended the support for the RSYNC_CONNECT_PROG variable
 197       that can be used to enhance the client side of a daemon connection.
 198
 199     - Improved the dashes and double-quotes in the nroff manpage output.
 200
 201     - We now support a lot more --no-OPTION override options.
 202
 203   INTERNAL:
 204
 205     - The file-list sorting algorithm now uses a sort that keeps any same-
 206       named items in the same order as they were specified.  This allows
 207       rsync to always ensure that the first of the duplicates is the one
 208       that will be included in the copy.  The new sort was also faster
 209       than the glibc version of qsort() and mergesort() in my testing.
 210
 211     - Rsync now supports the transfer of 64-bit timestamps (time_t values).
 212
 213     - Fixed a build problem with older (2.x) versions of gcc.
 214
 215     - Added some isType() functions that make dealing with signed characters
 216       easier without forcing variables via casts.
 217
 218     - Changed strcat/strcpy/sprintf function calls to use safer versions.
 219
 220     - Upgraded the included popt version to 1.10.2 and improved its use of
 221       string-handling functions.
 222
 223     - Added missing prototypes for compatibility functions from the lib dir.
 224
 225     - Configure determines if iconv() has a const arg, allowing us to avoid a
 226       compiler warning.
 227
 228     - Made the sending of some numbers more efficient for protocol 30.
 229
 230     - Make sure that a daemon process doesn't mind if the client was weird and
 231       omitted the --server option.
 232
 233     - There are more internal logging categories available in protocol 30 than
 234       the age-old FINFO and FERROR, including FERROR_XFER and FWARN.  These new
 235       categories allow some errors and warnings to go to stderr without causing
 236       an erroneous end-of-run warning about some files not being able to be
 237       transferred.
 238
 239     - Improved the use of "const" on pointers.
 240
 241     - Improved J.W.'s pool_alloc routines to add a way of freeing older
 242       sections of a pool's memory.
 243
 244     - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
 245       some new code (derived from samba, derived from PostgreSQL) that has a
 246       better license than the old code.
 247
 248   DEVELOPER RELATED:
 249
 250     - Rsync is now licensed under the GPLv3 or later.
 251
 252     - Rsync is now being maintained in a "git" repository instead of CVS
 253       (though the old CVS repository still exists).  Several maintenance
 254       scripts were updated to work with git.
 255
 256     - Generated files are no longer committed into the source repository.  The
 257       autoconf and autoheader commands are now automatically run during the
 258       normal use of "configure" and "make".  The latest dev versions of all
 259       generated files can also be copied from the samba.org web site (see the
 260       "magic" configure script that now comes with rsync for its location).
 261
 262     - The "patches" directory of diff files is now built from branches in the
 263       rsync git repository (branch patch/FOO creates file patches/FOO.diff).
 264
 265     - The proto.h file is now built using a simple perl script rather than a
 266       complex awk script, which proved to be more widely compatible.
 267
 268     - When running the tests, we now put our per-test temp dirs into a sub-
 269       directory named testtmp (which is created, if missing).  This allows
 270       someone to symlink the testtmp directory to another filesystem (which is
 271       useful if the build dir's filesystem does not support ACLs and xattrs,
 272       but another file system does).
 273
 274     - Rsync now has a way of handling protocol-version changes during the
 275       development of a new protocol version.  This causes any out-of-sync
 276       versions to speak an older protocol rather than fail in a cryptic manner.
 277       This addition makes it safe to deploy a pre-release version that may
 278       interact with the public.  This new exchange of sub-version info does not
 279       interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
 280       does not have enough range to allow the main protocol number to be
 281       incremented for every minor tweak in that happens during development).
 282
 283     - The csprotocol.txt file was updated to mention the daemon protocol change
 284       in the 3.0.0 release.