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