-NEWS for rsync 2.6.9 (6 Nov 2006)
-Protocol: 29 (unchanged)
-Changes since 2.6.8:
+NEWS for rsync 3.0.0 (UNRELEASED)
+Protocol: 30 (changed)
+Changes since 2.6.9:
+
+ NOTABLE CHANGES IN BEHAVIOR:
+
+ - The handling of implied directories when using --relative has changed to
+ send them as directories (e.g. no implied dir is ever sent as a symlink).
+ This avoids unexpected behavior and should not adversely affect most
+ people. If you're one of those rare individuals who relied upon having
+ an implied dir be duplicated as a symlink, you should specify the
+ transfer of the symlink and the transfer of the referent directory as
+ separate args. (See also --keep-dirlinks and --no-implied-dirs.)
+ Also, exclude rules no longer have a partial effect on implied dirs.
+
+ - Requesting a remote file-listing without specifying -r (--recursive) now
+ sends the -d (--dirs) option to the remote rsync rather than sending -r
+ along with an extra exclude of /*/*. If the remote rsync does not
+ understand the -d option (i.e. it is 2.6.3 or older), you will need to
+ either turn off -d (--no-d), or specify -r --exclude='/*/*' manually.
+
+ - In --dry-run mode, the last line of the verbose summary text is output
+ with a "(DRY RUN)" suffix to help remind you that no updates were made.
+ Similarly, --only-write-batch outputs "(BATCH ONLY)".
+
+ - A writable rsync daemon with "use chroot" disabled now defaults to a
+ symlink-munging behavior designed to make symlinks safer while also
+ allowing absolute symlinks to be stored and retrieved. This also has
+ the effect of making symlinks unusable while they're in the daemon's
+ hierarchy. See the daemon's "munge symlinks" parameter for details.
+
+ - Starting up an extra copy of an rsync daemon will not clobber the pidfile
+ for the running daemon -- if the pidfile exists, the new daemon will exit
+ with an error. This means that your wrapper script that starts the rsync
+ daemon should be made to handle lock-breaking (if you want any automatic
+ breaking of locks to be done).
BUG FIXES:
- - If rsync is interrupted via a handled signal (such as SIGINT), it will
- once again clean-up its temp file from the destination dir.
+ - A daemon with "use chroot = no" and excluded items listed in the daemon
+ config file now properly checks an absolute-path arg specified for these
+ options: --compare-dest, --link-dest, --copy-dest, --partial-dir,
+ --backup-dir, --temp-dir, and --files-from.
- - Fixed an overzealous sanitizing bug in the handling of the --link-dest,
- --copy-dest, and --compare-dest options to a daemon without chroot: if
- the copy's destination dir is deeper than the top of the module's path,
- these options now accept a safe number of parent-dir (../) references
- (since these options are relative to the destination dir). The old code
- incorrectly chopped off all "../" prefixes for these options, no matter
- how deep the destination directory was in the module's hierarchy.
+ - A daemon can now be told to disable all user- and group-name translation
+ on a per-module basis. This avoids a potential problem with a writable
+ daemon module that has "use chroot" enabled -- if precautions weren't
+ taken, a user could try to add a missing library and get rsync to use
+ it. This makes rsync safer by default, and more configurable when id-
+ translation is not desired. See the daemon's "numeric ids" parameter
+ for full details.
- - Fixed a bug where a deferred info/error/log message could get sent
- directly to the sender instead of being handled by rwrite() in the
- generator. This fixes an "unexpected tag 3" fatal error, and should
- also fix a potential problem where a deferred info/error message from
- the receiver might bypass the log file and get sent only to the client
- process. (These problems could only affect an rsync daemon that was
- receiving files.)
+ - A chroot daemon can now indicate which part of its path should affect the
+ chroot call, and which part should become an inside-chroot path for the
+ module. This allows you to have outside-the-transfer paths (such as for
+ libraries) even when you enable chroot protection. The idiom used in the
+ rsyncd.conf file is: path = /chroot/dirs/./dirs/inside
- - Fixed a bug when --inplace was combined with a --*-dest option and we
- update a file's data using an alternate basis file. The code now
- notices that it needs to copy the matching data from the basis file
- instead of (wrongly) assuming that it was already present in the file.
+ - If a file's data arrived successfully on the receiving side but the
+ rename of the temporary file to the destination file failed AND the
+ --remove-source-files (or the deprecated --remove-sent-files) option
+ was specified, rsync no longer erroneously removes the associated
+ source file.
- - Fixed a bug where using --dry-run with a --*-dest option with a path
- relative to a directory that does not yet exist: the affected option
- gets its proper path value so that the output of the dry-run is right.
+ - Fixed the output of -ii when combined with one of the --*-dest options:
+ it now itemizes all the items, not just the changed ones.
- - Fixed a bug in the %f logfile escape when receiving files: the
- destination path is now included in the output (e.g. you can now tell
- when a user specifies a subdir inside a module).
+ - Made the output of all file types consistent when using a --*-dest
+ option. Prior versions would output too many creation events for
+ matching items.
- - If the receiving side fails to create a directory, it will now skip
- trying to update everything that is inside that directory.
+ - The code that waits for a child pid now handles being interrupted by a
+ signal. This fixes a problem with the pre-xfer exec function not being
+ able to get the exit status from the script.
- - If --link-dest is specified with --checksum but without --times, rsync
- will now allow a hard-link to be created to a matching link-dest file
- even when the file's modify-time doesn't match the server's file.
+ - A negated filter rule (i.e. with a '!' modifier) no longer loses the
+ negation when sending the filter rules to the remote rsync.
- - The daemon now calls more timezone-using functions prior to doing a
- chroot. This should help some C libraries to generate proper timestamps
- from inside a chrooted daemon (and to not try to access /etc/timezone
- over and over again).
+ - Fixed a problem with the --out-format (aka --log-format) option %f: it
+ no longer outputs superfluous directory info for a non-daemon rsync.
- - Fixed a bug in the handling of an absolute --partial-dir=ABS_PATH option:
- it now deletes an alternate basis file from the partial-dir that was used
- to successfully update a destination file.
+ - Fixed a problem with -vv (double --verbose) and --stats when "pushing"
+ files (which includes local copies). Version 2.6.9 would complete the
+ copy, but exit with an error when the receiver output its memory stats.
- - Fixed a bug in the handling of --delete-excluded when using a per-dir
- merge file: the merge file is now honored on the receiving side, and
- only its unqualified include/exclude commands are ignored (just as is
- done for global include/excludes).
+ - If --password-file is used on a non-daemon transfer, rsync now complains
+ and exits. This should help users figure out that they can't use this
+ option to control a remote shell's password prompt.
- - Fixed a recent bug where --delete was not working when transferring from
- the root (/) of the filesystem with --relative enabled.
+ - Make sure that directory permissions of a newly-created destination
+ directory are handled right when --perms is left off.
- - Fixed a recent bug where an --exclude='*' could affect the root (/) of
- the filesystem with --relative enabled.
+ - The itemized output of a newly-created destination directory is now
+ output as a creation event, not a change event.
- - When --inplace creates a file, it is now created with owner read/write
- permissions (0600) instead of no permissions at all. This avoids a
- problem continuing a transfer that was interrupted (since --inplace
- will not update a file that has no write permissions).
+ - Improved --hard-link so that more corner cases are handled correctly
+ when combined with options such as --link-dest and/or --ignore-existing.
- - If either --remove-source-files or --remove-sent-files is enabled and we
- are unable to remove the source file, rsync now outputs an error.
+ - The --append option no longer updates a file that has the same size.
- - Fixed a bug in the daemon's "incoming chmod" rule: newly-created
- directories no longer get the 'F' (file) rules applied to them.
+ - Fixed a bug when combining --backup and --backup-dir with --inplace:
+ any missing backup directories are now created.
- - Fixed an infinite loop bug when a filter rule was rejected due to being
- overly long.
+ - Fixed a bug when using --backup and --inplace with --whole-file or
+ --read-batch: backup files are actually created now.
- - When the server receives a --partial-dir option from the client, it no
- longer runs the client-side code that adds an assumed filter rule (since
- the client will be sending us the rules in the usual manner, and they
- may have chosen to override the auto-added rule).
+ - The daemon pidfile is checked and created sooner in the startup sequence.
- ENHANCEMENTS:
+ - If a daemon module's "path" value is not an absolute pathname, the code
+ now makes it absolute internally (making it work properly).
+
+ - Ensure that a temporary file always has owner-write permission while we
+ are writing to it. This avoids problems with some network filesystems
+ when transfering read-only files.
- - Added the --log-file=FILE and --log-file-format=FORMAT options. These
- can be used to tell any rsync to output what it is doing to a log file.
- They work with a client rsync, a non-daemon server rsync (see the man
- page for instructions), and also allows the overriding of rsyncd.conf
- settings when starting a daemon.
+ - Any errors output about password-file reading no longer cause an error at
+ the end of the run about a partial transfer.
- - The --log-format option was renamed to be --out-format to avoid confusing
- it with affecting the log-file output. (The old option remains as an
- alias for the new to preserve backward compatibility.)
+ - The --read-batch option for protocol 30 now ensures that several more
+ options are set correctly for the current batch file: --iconv, --acls,
+ --xattrs, --inplace, --append, and --append-verify.
- - Made "log file" and "syslog facility" settable on a per-module basis in
- the daemon's config file.
+ - Using --only-write-batch to a daemon receiver now works properly (older
+ versions would update some files while writing the batch).
- - Added the --remove-source-files option as a replacement for the (now
- deprecated) --remove-sent-files option. This new option removes all
- non-dirs from the source directories, even if the file was already
- up-to-date. This fixes a problem where interrupting an rsync that
- was using --remove-sent-files and restarting it could leave behind
- a file that the earlier rsync synchronized, but didn't get to remove.
- (The deprecated --remove-sent-files is still understood for now, and
- still behaves in the same way as before.)
+ - Avoid outputting a "file has vanished" message when the file is a broken
+ symlink and --copy-unsafe-links or --copy-dirlinks is used (the code
+ already handled this for --copy-links).
- - Added the option --no-motd to suppress the message-of-the-day output
- from a daemon when doing a copy. (See the manpage for a caveat.)
+ - Fixed the combination of --only-write-batch and --dry-run.
+
+ ENHANCEMENTS:
- - Added a new environment variable to the pre-/post-xfer exec commands (in
- the daemon's config file): RSYNC_PID. This value will be the same in
- both the pre- and post-xfer commands, so it can be used if the pre-xfer
- command wants to cache some arg/request info for the post-xfer command.
+ - A new incremental-recursion algorithm is now used when rsync is talking
+ to another 3.x version. This starts the transfer going more quickly
+ (before all the files have been found), and requires much less memory.
+ See the --recursive option in the manpage for some restrictions.
+
+ - Lowered memory use in the non-incremental-recursion algorithm for typical
+ option values (usually saving from 21-29 bytes per file).
+
+ - The default --delete algorithm is now --delete-during when talking to a
+ 3.x rsync. This is a faster scan than using --delete-before (which is
+ the default when talking to older rsync versions), and is compatible with
+ the new incremental recursion mode.
+
+ - Rsync now allows multiple remote-source args to be specified rather than
+ having to rely on a special space-splitting side-effect of the remote-
+ shell. Additional remote args must specify the same host or an empty one
+ (e.g. empty: :file1 or ::module/file2). For example, this means that
+ local use of brace expansion now works: rsync -av host:dir/{f1,f2} .
+
+ - Added the --protect-args (-s) option, that tells rsync to send most of
+ the command-line args at the start of the transfer rather than as args
+ to the remote-shell command. This protects them from space-splitting,
+ and only interprets basic wildcard special shell characters (*?[).
+
+ - Added the --delete-delay option, which is a more efficient way to delete
+ files at the end of the transfer without needing a separate delete pass.
+
+ - Added the --acls (-A) option to preserve Access Control Lists. This is
+ an improved version of the prior patch that was available, and it even
+ supports OS X ACLs. If you need to have backward compatibility with old,
+ ACL-patched versions of rsync, apply the acls.diff file from the patches
+ dir.
+
+ - Added the --xattrs (-X) option to preserve extended attributes. This is
+ an improved version of the prior patch that was available, and it even
+ supports OS X xattrs (which includes their resource fork data). If you
+ need to have backward compatibility with old, xattr-patched versions of
+ rsync, apply the xattrs.diff file from the patches dir.
+
+ - Added the --fake-super option that allows a non-super user to preserve
+ all attributes of a file by using a special extended-attribute idiom.
+ It even supports the storing of foreign ACL data on your backup server.
+ There is also an analogous "fake super" parameter for an rsync daemon.
+
+ - Added the --iconv option, which allows rsync to convert filenames from
+ one character-set to another during the transfer. The default is to
+ make this feature available as long as your system has iconv_open().
+ If compilation fails, specify --disable-iconv to configure, and then
+ rebuild. If you want rsync to perform character-set conversions by
+ default, you can specify --enable-iconv=CONVERT_STRING with the default
+ value for the --iconv option that you wish to use. For example,
+ "--enable-iconv=." is a good choice. See the rsync manpage for an
+ explanation of the --iconv option's settings.
+
+ - A new daemon config parameter, "charset", lets you control the character-
+ set that is used during an --iconv transfer to/from a daemon module. You
+ can also set your daemon to refuse "no-iconv" if you want to force the
+ client to use an --iconv transfer (requiring an rsync 3.x client).
+
+ - Added the --skip-compress=LIST option to override the default list of
+ file suffixes that will not be compressed when using --compress (-z).
+
+ - The daemon's default for "dont compress" was extended to include:
+ *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
+ The name-matching routine was also optimized to run more quickly.
+
+ - The --max-delete option now outputs a warning if it skipped any file
+ deletions, including a count of how many deletions were skipped. (Older
+ versions just silently stopped deleting things.)
+
+ - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
+ about extraneous files without deleting anything. If you're not sure
+ what version the client is, you can use the less-obvious --max-delete=-1,
+ as both old and new versions will treat that as the same request (though
+ older versions don't warn).
+
+ - The --hard-link option now uses less memory on both the sending and
+ receiving side for all protocol versions. For protocol 30, the use of a
+ hashtable on the sending side allows us to more efficiently convey to the
+ receiver what files are linked together. This reduces the amount of data
+ sent over the socket by a considerable margin (rather than adding more
+ data), and limits the in-memory storage of the device+inode information
+ to just the sending side for the new protocol 30, or to the receiving
+ side when speaking an older protocol (note that older rsync versions kept
+ the device+inode information on both sides).
+
+ - The filter rules now support a perishable ("p") modifier that marks rules
+ that should not have an effect in a directory that is being deleted. e.g.
+ -f '-p .svn/' would only affect "live" .svn directories.
+
+ - Rsync checks all the alternate-destination args for validity (e.g.
+ --link-dest). This lets the user know when they specified a directory
+ that does not exist.
+
+ - If we get an error setting the time on a symlink, we don't complain about
+ it anymore (since some operating systems don't support that, and it's not
+ that important).
+
+ - Protocol 30 now uses MD5 checksums instead of MD4.
+
+ - Changed the --append option to not checksum the existing data in the
+ destination file, which speeds up file appending.
+
+ - Added the --append-verify option, which works like the older --append
+ option (verifying the existing data in the destination file). For
+ compatibility with older rsync versions, any use of --append that is
+ talking protocol 29 or older will revert to the --append-verify method.
+
+ - Added the --contimeout=SECONDS option that lets the user specify a
+ connection timeout for rsync daemon access.
+
+ - Documented and extended the support for the RSYNC_CONNECT_PROG variable
+ that can be used to enhance the client side of a daemon connection.
+
+ - Improved the dashes and double-quotes in the nroff manpage output.
+
+ - Rsync now supports a lot more --no-OPTION override options.
INTERNAL:
- - Did a code audit using IBM's code-checker program and made several
- changes, including: replacing most of the strcpy() and sprintf()
- calls with strlcpy(), snprintf(), and memcpy(), adding a 0-value to
- an enum that had been intermingling a literal 0 with the defined enum
- values, silencing some uninitialized memory checks, marking some
- functions with a "noreturn" attribute, and changing an "if" that
- could never succeed on some platforms into a pre-processor directive
- that conditionally compiles the code.
+ - The file-list sorting algorithm now uses a sort that keeps any same-
+ named items in the same order as they were specified. This allows
+ rsync to always ensure that the first of the duplicates is the one
+ that will be included in the copy. The new sort is also faster
+ than the glibc version of qsort() and mergesort().
- - Fixed a potential bug in f_name_cmp() when both the args are a
- top-level "." dir (which doesn't happen in normal operations).
+ - Rsync now supports the transfer of 64-bit timestamps (time_t values).
- - Changed exit_cleanup() so that it can never return instead of exit.
- The old code might return if it found the exit_cleanup() function
- was being called recursively. The new code is segmented so that
- any recursive calls move on to the next step of the exit-processing.
+ - Made the file-deletion code use a little less stack when recursing
+ through a directory hierarchy of extraneous files.
- - The macro WIFEXITED(stat) will now be defined if the OS didn't already
- define it.
+ - Fixed a build problem with older (2.x) versions of gcc.
- DEVELOPER RELATED:
+ - Added some isType() functions that make dealing with signed characters
+ easier without forcing variables via casts.
+
+ - Changed strcat/strcpy/sprintf function calls to use safer versions.
+
+ - Upgraded the included popt version to 1.10.2 and improved its use of
+ string-handling functions.
- - The acls.diff and xattrs.diff patches have received a bunch of work to
- make them much closer to being acceptable in the main distribution.
- The xattrs patch also has some preliminary Mac OS X compatibility code
- that allows Macs and non-macs to exchange extended attributes.
+ - Added missing prototypes for compatibility functions from the lib dir.
- - A new diff in the patches dir, fake-root.diff, allows rsync to
- maintain a backup hierarchy with full owner, group, and device info
- without actually running as root. It does this using a special
- extended attribute, so it depends on xattrs.diff (which depends on
- acls.diff).
+ - Configure determines if iconv() has a const arg, allowing us to avoid a
+ compiler warning.
- - The rsync.yo and rsyncd.conf.yo files have been updated to work
- better with the latest yodl 2.x releases.
+ - Made the sending of some numbers more efficient for protocol 30.
- - Updated config.guess and config.sub to their 2006-02-23 version.
+ - Make sure that a daemon process doesn't mind if the client was weird and
+ omitted the --server option.
+
+ - There are more internal logging categories available in protocol 30 than
+ the age-old FINFO and FERROR, including FERROR_XFER and FWARN. These new
+ categories allow some errors and warnings to go to stderr without causing
+ an erroneous end-of-run warning about some files not being able to be
+ transferred.
+
+ - Improved the use of "const" on pointers.
+
+ - Improved J.W.'s pool_alloc routines to add a way of incrementally freeing
+ older sections of a pool's memory.
+
+ - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
+ some new code (derived from samba, derived from PostgreSQL) that has a
+ better license than the old code.
+
+ DEVELOPER RELATED:
- - Updated various files to include the latest FSF address and to have
- consistent opening comments.
+ - Rsync is now licensed under the GPLv3 or later.
+
+ - Rsync is now being maintained in a "git" repository instead of CVS
+ (though the old CVS repository still exists for historical access).
+ Several maintenance scripts were updated to work with git.
+
+ - Generated files are no longer committed into the source repository. The
+ autoconf and autoheader commands are now automatically run during the
+ normal use of "configure" and "make". The latest dev versions of all
+ generated files can also be copied from the samba.org web site (see the
+ prepare-source script's fetch option).
+
+ - The "patches" directory of diff files is now built from branches in the
+ rsync git repository (branch patch/FOO creates file patches/FOO.diff).
+
+ - The proto.h file is now built using a simple perl script rather than a
+ complex awk script, which proved to be more widely compatible.
+
+ - When running the tests, we now put our per-test temp dirs into a sub-
+ directory named testtmp (which is created, if missing). This allows
+ someone to symlink the testtmp directory to another filesystem (which is
+ useful if the build dir's filesystem does not support ACLs and xattrs,
+ but another filesystem does).
+
+ - Rsync now has a way of handling protocol-version changes during the
+ development of a new protocol version. This causes any out-of-sync
+ versions to speak an older protocol rather than fail in a cryptic manner.
+ This addition makes it safer to deploy a pre-release version that may
+ interact with the public. This new exchange of sub-version info does not
+ interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
+ does not have enough range to allow the main protocol number to be
+ incremented for every minor tweak in that happens during development).
+
+ - The csprotocol.txt file was updated to mention the daemon protocol change
+ in the 3.0.0 release.