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