NEWS for rsync 2.6.4 (UNRELEASED)
-Protocol: 28 (unchanged)
+Protocol: 29 (changed)
Changes since 2.6.3:
+ OUTPUT CHANGES:
+
+ - When rsync deletes a directory and outputs a verbose message about
+ it, it now appends a trailing slash to the name instead of (only
+ sometimes) outputting a preceding "directory " string.
+
+ - The --stats output will contain file-list time-statistics if both
+ sides are 2.6.4, or if the local side is 2.6.4 and the files are
+ being pushed (since the stats come from the sending side).
+ (Requires protocol 29 for a pull.)
+
+ - The "%o" (operation) log-format escape now has a third value (besides
+ "send" and "recv"): "del." (with trailing dot to make it 4 chars).
+ This changes the way deletions are logged in the daemon's log file.
+
+ - When the --log-format option is combined with --verbose, rsync now
+ avoids outputting the name of the file twice in most circumstances.
+ As long as the --log-format item does not refer to any post-transfer
+ items (such as %b or %c), the --log-format message is output prior to
+ the transfer with --verbose being the equivalent of a --log-format of
+ '%n%L' (which outputs the name and any symlink info). If the log
+ output must occur after the transfer to be complete, the only time
+ the name is also output prior to the transfer is when --progress was
+ specified (so that the name will precede the progress stats, and the
+ full --log-format output will come after).
+
BUG FIXES:
- Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
was only treating it as a special token in an rsync include/exclude
file).
- - An OS that has a binary mode for its files (such as cygwin0 needed
+ - The combination of --verbose and --dry-run now mentions the full list
+ of changes that would be output without --dry-run.
+
+ - Avoid a mkdir warning when removing a directory in the destination
+ that already exists in the --backup-dir.
+
+ - An OS that has a binary mode for its files (such as cygwin) needed
setmode(fd, O_BINARY) called on the temp-file we opened with
- mkstemp().
+ mkstemp(). (Fix derived from the cygwin's 2.6.3 rsync package.)
+
+ - Fixed a potential hang when verbosity is high, the client side is
+ the sender, and the file-list is large.
- We now check if the OS doesn't support using mknod() for creating
FIFOs and sockets, and compile-in using mkfifo() and socket() when
necessary.
- ENHANCEMENTS:
-
- - In _exit_cleanup(): when we are exiting with a partially-received
- file, we now flush any data in the write-cache before closing the
- partial file.
-
- BUILD CHANGES:
-
- - Support an OS that uses mkdev() instead of makedev().
-
-\f
-NEWS for rsync 2.6.3 (30 Sep 2004)
-Protocol: 28 (unchanged)
-Changes since 2.6.2:
-
- SECURITY FIXES:
-
- - A bug in the sanitize_path routine (which affects a non-chrooted
- rsync daemon) could allow a user to craft a pathname that would get
- transformed into an absolute path for certain options (but not for
- file-transfer names). If you're running an rsync daemon with chroot
- disabled, *please upgrade*, ESPECIALLY if the user privs you run
- rsync under is anything above "nobody".
-
- OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
-
- - Please note that the 2-line footer (output when verbose) now uses the
- term "sent" instead of "wrote" and "received" instead of "read". If
- you are not parsing the numeric values out of this footer, a script
- would be better off using the empty line prior to the footer as the
- indicator that the verbose output is over.
-
- - The output from the --stats option was similarly affected to change
- "written" to "sent" and "read" to "received".
-
- - Rsync ensures that a filename that contains a newline gets mentioned
- with each newline transformed into a question mark (which prevents a
- filename from causing an empty line to be output).
-
- - The "backed up ..." message that is output when at least 2 --verbose
- options are specified is now the same both with and without the
- --backup-dir option.
-
- BUG FIXES:
-
- - Fixed a crash bug that might appear when --delete was used and
- multiple source directories were specified.
-
- - Fixed a 32-bit truncation of the file length when generating the
- checksums.
-
- - The --backup code no longer attempts to create some directories
- over and over again (generating warnings along the way).
-
- - Fixed a bug in the reading of the secrets file (by the daemon) and
- the password file (by the client): the files no longer need to be
- terminated by a newline for their content to be read in.
-
- - If a file has a read error on the sending side or the reconstructed
- data doesn't match the expected checksum (perhaps due to the basis
- file changing during the transfer), the receiver will no longer
- retain the resulting file unless the --partial option was specified.
- (Note: for the read-error detection to work, neither side can be
- older than 2.6.3 -- older receivers will always retain the file, and
- older senders don't tell the receiver that the file had a read
- error.)
-
- - If a file gets resent in a single transfer and the --backup option
- is enabled, rsync no longer performs a duplicate backup (it used to
- overwrite the original file in the backup area).
+ - Fixed an off-by-one error in the handling of --max-delete=N.
- - Files specified in the daemon's "exclude" or "exclude from" config
- items are now excluded from being uploaded (assuming that the module
- allows uploading at all) in addition to the old download exclusion.
+ - One place in the code wasn't checking if fork() failed.
- - Got rid of a potential hang in the receiver when near the end of a
- phase.
+ - The "ignore nonreadable" daemon parameter used to erroneously affect
+ symlinks that pointed to a non-existent file. This has been fixed.
- - When using --backup without a --backup-dir, rsync no longer preserves
- the modify time on directories. This avoids confusing NFS.
+ - If the OS does not have lchown() and a chown() of a symlink will
+ affect the referent of a symlink (as it should), we no longer try
+ to set the user and group of a symlink.
- - When --copy-links (-L) is specified, we now output a separate error
- for a symlink that has no referent instead of claiming that a file
- "vanished".
+ - The generator now properly runs the hard-link loop and the dir-time
+ rewriting loop after we're sure that the redo phase is complete.
- - The --copy-links (-L) option no longer has the side-effect of telling
- the receiving side to follow symlinks. See the --keep-dirlinks
- option (mentioned below) for a way to specify that behavior.
+ - When --backup was specified with --partial-dir=DIR (where DIR is a
+ relative path), the backup code was erroneously trying to backup a
+ file that was put into the partial-dir.
- - Error messages from the daemon server's option-parsing (such as
- refused options) are now successfully transferred back to the client
- (the server used to fail to send the message because the socket
- wasn't in the right state for the message to get through).
+ - One call to flush_write_file() was not being checked for an error.
- - Most transfer errors that occur during a daemon transfer are now
- returned to the user in addition to being logged (some messages are
- intended to be daemon-only and are not affected by this).
+ - The --no-relative option was not being sent from the client to a
+ server sender.
- - Fixed a bug in the daemon authentication code when using one of the
- batch-processing options.
+ - If an rsync daemon specified "dont compress = ..." for a file and the
+ client tried to specify --compress, the libz code was not handling a
+ compression level of 0 properly. This could cause a transfer failure
+ if the block-size for a file was large enough (e.g. rsync might have
+ exited with an error for large files).
- - We try to work around some buggy IPv6 implementations that fail to
- implement IPV6_V6ONLY. This should fix the "address in use" error
- that some daemons get when running on an OS with a buggy IPv6
- implementation. Also, if the new code gets this error, we might
- suggest that the user specify --ipv4 or --ipv6 (if we think it will
- help).
+ - Fixed a bug that would sometimes surface when using --compress and
+ sending a file with a block-size larger than 64K (either manually
+ specified, or computed due to the file being really large). Prior
+ versions of rsync would sometimes fail to decompress the data
+ properly, and thus the transferred file would fail its verification.
- - When the remote rsync dies, make a better effort to recover any error
- messages it may have sent before dying (the local rsync used to just
- die with a socket-write error).
+ - If a daemon can't open the specified log file (i.e. syslog is not
+ being used), die without crashing. We also output an error about
+ the failure on stderr (which will only be seen if --no-detach was
+ specified).
- - When using --delete and a --backup-dir that contains files that are
- hard-linked to their destination equivalents, rsync now makes sure
- that removed files really get removed (avoids a really weird rename()
- behavior).
+ - A local transfer no longer duplicates all its include/exclude options
+ (since the forked process already has a copy of the exclude list,
+ there's no need to send them a set of duplicates).
- - Avoid a bogus run-time complaint about a lack of 64-bit integers when
- the int64 type is defined as an off_t and it actually has 64-bits.
+ - When --progress is specified, the output of items that the generator
+ is creating (e.g. dirs, symlinks) is now integrated into the progress
+ output without overlapping it. (Requires protocol 29.)
- - Added a configure check for open64() without mkstemp64() so that we
- can avoid using mkstemp() when such a combination is encountered.
- This bypasses a problem writing out large temp files on OSes such as
- AIX and HP-UX.
+ - When --timeout is specified, lulls in the transfer while the
+ generator scanning the file system (either looking for files to send
+ or files to delete) now generate a new keep-alive packet that will
+ keep the transfer going (as long as the generator continues to make
+ progress). (Requires protocol 29.)
- - Fixed an age-old crash problem with --read-batch on a local copy
- (rsync was improperly assuming --whole-file for the local copy).
-
- - When --dry-run (-n) is used and the destination directory does not
- exist, rsync now produces a correct report of files that would be
- sent instead of dying with a chdir() error.
-
- - Fixed a bug that could cause a slow-to-connect rsync daemon to die
- with an error instead of waiting for the connection to finish.
-
- - Fixed an ssh interaction that could cause output to be lost when the
- user chose to combine the output of rsync's stdout and stderr (e.g.
- using the "2>&1").
+ - The stat size of a device is not added to the total file size of the
+ items we encounter since it might be undefined on some OSes.
ENHANCEMENTS:
- - Added the --partial-dir=DIR option that lets you specify where to
- (temporarily) put a partially transferred file (instead of over-
- writing the destination file). E.g. --partial-dir=.rsync-partial
- Also added support for the RSYNC_PARTIAL_DIR environment variable
- that, when found, transforms a regular --partial option (such as
- the convenient -P option) into one that also specifies a directory.
-
- - Added --keep-dirlinks (-K), which allows you to symlink a directory
- onto another partition on the receiving side and have rsync treat it
- as matching a normal directory from the sender.
-
- - Added the --inplace option that tells rsync to write each destination
- file without using a temporary file. The matching of existing data
- in the destination file can be severely limited by this, but there
- are also cases where this is more efficient (such as appending data).
- Use only when needed (see the man page for more details).
-
- - Added the "write only" option for the daemon's config file.
-
- - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
- and documented all these options in the man page.
+ - Rsync now supports popt's option aliases, which means that you can
+ use /etc/popt and/or ~/.popt to create your own option aliases.
- - Improved the handling of the --bwlimit option so that it's less
- bursty, more accurate, and works properly over a larger range of
- values.
+ - Added the --delete-during (--del) option which will delete files
+ from the receiving side incrementally as each directory in the
+ transfer is being processed. This makes it more efficient than the
+ default, before-the-transfer behavior, which is now available as
+ --delete-before (and is still the default --delete-WHEN option that
+ will be chosen if --delete or --delete-excluded is specified without
+ a --delete-WHEN choice). All the --del* options infer --delete, so
+ an rsync daemon that refuses "delete" will still refuse to allow any
+ file-deleting options.
- - The rsync daemon-over-ssh code now looks for SSH_CONNECTION and
- SSH2_CLIENT in addition to SSH_CLIENT to figure out the IP address.
+ - All the --delete-WHEN options are now more memory efficient:
+ Previously an entire duplicate set of file-list objects was created
+ on the receiving side for the entire destination hierarchy. The new
+ algorithm only creates one directory of objects at a time (for files
+ inside the transfer).
- - Added the --checksum-seed=N option for advanced users.
+ - Added support for specifying multiple --compare-dest or --link-dest
+ options, but only of a single type. (Promoted from the patches dir
+ and enhanced.)
- - Batch writing/reading has a brand-new implementation that is simpler,
- fixes a few weird problems with the old code (such as no longer
- sprinkling the batch files into different dirs or even onto different
- systems), and is much less intrusive into the code (making it easier
- to maintain for the future). The new code generates just one data
- file instead of three, which makes it possible to read the batch on
- stdin via a remote shell. Also, the old requirement of forcing the
- same fixed checksum-seed for all batch processing has been removed.
+ - Added the --max-size option. (Promoted from the patches dir.)
- - If an rsync daemon has a module set with "list = no" (which hides its
- presence in the list of available modules), a user that fails to
- authenticate gets the same "unknown module" error that they would get
- if the module were actually unknown (while still logging the real
- error to the daemon's log file). This prevents fishing for module
- names.
+ - The daemon-mode options were separated from the normal rsync options
+ so that they can't be mixed together. This makes it impossible to
+ start a daemon that had improper default option values that could
+ cause problems when a client connects (e.g. a hang or an abort).
- - The daemon's "refuse options" config item now allows you to match
- option names using wildcards and/or the single-letter option names.
+ - The --bwlimit option may now be used in combination with --daemon
+ to specify both a default value for the daemon side and a value
+ that cannot be exceeded by a user-specified --bwlimit option.
- - Each transferred file now gets its permissions and modified-time
- updated before the temp-file gets moved into place. Previously, the
- finished file would have a very brief window where its permissions
- disallowed all group and world access.
+ - Added the "port" parameter to the rsyncd.conf file. (Promoted from
+ the patches dir.) Also added "address". A command-line option
+ will take precedence over a config-file option, as expected.
- - Added the ability to parse a literal IPv6 address in an "rsync:" URL
- (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
+ - In _exit_cleanup(): when we are exiting with a partially-received
+ file, we now flush any data in the write-cache before closing the
+ partial file.
- - The daemon's wildcard expanding code can now handle more than 1000
- filenames (it's now limited by memory instead of having a hard-wired
- limit).
+ - The --inplace support was enhanced to work with --compare-dest and
+ --link-dest. (Requires protocol 29.)
+
+ - Added the --dirs (-d) option for an easier way to copy directories
+ without recursion.
+
+ - Added the --list-only option, which is mainly a way for the client to
+ put the server into listing mode without needing to resort to any
+ internal option kluges (e.g. the age-old use of "-r --exclude="/*/*"
+ for a non-recursive listing). This option is used automatically
+ (behind the scenes) when a modern rsync speaks to a modern daemon,
+ but may also be specified manually if you want to force the use of
+ the --list-only option over a remote-shell connection.
+
+ - Added the --omit-dir-times (-O) option, which will avoid updating
+ the modified time for directories when --times was specified. This
+ option will avoid an extra pass through the file-list at the end of
+ the transfer (to tweak all the directory times), which can result in
+ an appreciable speedup for a really large transfer. (Promoted from
+ the patches dir.)
+
+ - Added the --filter (-f) option and its helper option, -F. Filter
+ rules are an extension to the existing include/exclude handling
+ that also supports nested filter files as well as per-directory
+ filter files (like .cvsignore, but with full filter-rule parsing).
+ This new option was chosen in order to ensure that all existing
+ include/exclude processing remained 100% compatible with older
+ versions. Protocol 29 is needed for full filter-rule support, but
+ backward-compatible rules work with earlier protocol versions.
+ (Promoted from the patches dir and enhanced.)
+
+ - Added the --delay-updates option that puts all updated files into
+ a temporary directory (by default ".~tmp~", but settable via the
+ --partial-dir=DIR option) until the end of the transfer. This
+ makes the updates a little more atomic for a large transfer.
+
+ - If rsync is put into the background, any output from --progress is
+ reduced.
+
+ - Documented the "max verbosity" setting for rsyncd.conf. (This
+ setting was added a couple releases ago, but left undocumented.)
+
+ - The sender and the generator now double-check the file-list index
+ they are given, and refuse to try to do a file transfer on a
+ non-file index (since that would indicate that something had gone
+ very wrong).
+
+ - Added the --itemize-changes (-i) option, which is a way to output a
+ more detailed list of what files changed in any way and how they
+ changed. The effect is the same as specifying a --log-format of
+ "%i %n%L" (see the rsyncd.conf manpage). Works with --dry-run too.
+
+ - Added the --fuzzy option, which attempts to find a basis file for a
+ file that is being created from scratch. The current algorithm
+ only looks in the destination directory for the created file, but
+ it does attempt to find a match based on size/mod-time (in case the
+ file was renamed with no other changes) as well as based on a fuzzy
+ name-matching algorithm. This option requires protocol 29 because
+ it needs the new file-sorting order. (Promoted from patches dir
+ and enhanced.)
+
+ - Added the --remove-sent-files option, which lets you move files
+ between systems.
+
+ - When building under windows, the default for --daemon is now to
+ avoid detaching, requiring the new --detach option to force rsync
+ to detach.
+
+ - Improved the option descriptions in the --help text.
+
+ SUPPORT FILES:
+
+ - Added atomic-rsync to the support dir: a perl script that will
+ transfer some files using rsync, and then move the updated files into
+ place all at once at the end of the transfer. Only works when
+ pulling, and uses --link-dest and a parallel hierarchy of files to
+ effect its update.
+
+ - Added mnt-excl to the support dir: a perl script that takes the
+ /proc/mounts file and translates it into a set of excludes that will
+ exclude all mount points (even mapped mounts to the same disk). The
+ excludes are made relative to the specified source dir and properly
+ anchored.
+
+ - Added savetransfer.c to the support dir: a C program that can make
+ a copy of all the data that flows over the wire. This lets you test
+ for data corruption (by saving the data on both the sending side and
+ the receiving side) or provides a way to help debug a protocol error.
+
+ - Added rrsync to the support dir: this is my version of Joe Smith's
+ restricted rsync perl script. This helps to ensure that only certain
+ rsync commands can be run by an ssh invocation.
INTERNAL:
- - Some cleanup in the exclude code has saved some per-exclude memory
- and made the code easier to maintain.
-
- - Improved the argv-overflow checking for a remote command that has a
- lot of args.
-
- - Use rsyserr() in the various places that were still calling rprintf()
- with strerror() as an arg.
-
- - If an rsync daemon is listening on multiple sockets (to handle both
- IPv4 and IPv6 to a single port), we now close all the unneeded file
- handles after we accept a connection (we used to close just one of
- them).
-
- - Optimized the handling of larger block sizes (rsync used to slow to a
- crawl if the block size got too large).
-
- - Optimized away a loop in hash_search().
-
- - Some improvements to the sanitize_path() and clean_fname() functions
- makes them more efficient and produce better results (while still
- being compatible with the file-name cleaning that gets done on both
- sides when sending the file-list).
-
- - Got rid of alloc_sanitize_path() after adding a destination-buffer
- arg to sanitize_path() made it possible to put all the former's
- functionality into the latter.
-
- - The file-list that is output when at least 4 verbose options are
- specified reports the uid value on the sender even when rsync is
- not running as root (since we might be sending to a root receiver).
+ - Added better checking of the checksum-header values that come over
+ the socket.
+
+ - Merged a variety of file-deleting functions into a single function so
+ that it is easier to maintain.
+
+ - Improved the type of some variables (particularly blocksize vars) for
+ consistency and proper size.
+
+ - Got rid of the uint64 type (which we didn't need).
+
+ - Use a slightly more compatible set of core #include directives.
+
+ - Defined int32 in a way that ensures that the build dies if we can't
+ find a variable with at least 32 bits.
+
+ - The daemon's "read only" config item now sets an internal read_only
+ variable that makes extra sure that no write/delete calls on the
+ read-only side can succeed.
+
+ PROTOCOL DIFFERENCES FOR VERSION 29:
+
+ - A 16-bit flag-word is transmitted after every file-list index. This
+ indicates what is changing between the sender and the receiver. The
+ generator now transmits an index and a flag-word to indicate when
+ dirs and symlinks have changed (instead of producing a message),
+ which makes the outputting of the information more consistent and
+ less prone to screen corruption (because either the receiver or the
+ sender is now outputting all the file-change info).
+
+ - If --inplace is specified, the generator flags any transfer that is
+ using an alternate basis file so that the sender can use the entire
+ file in the rsync algorithm (unlike a normal --inplace update).
+
+ - The sending of exclude names is done using filter-rule syntax. This
+ means that all names have a prefixed rule indicator, even excludes
+ (which used to be sent as a bare pattern, when possible). The -C
+ option will include the per-dir .cvsignore merge file in the list of
+ filter rules so it is positioned correctly (unlike in some older
+ transfer scenarios).
+
+ - Rsync sorts the filename list in a different way: it sorts the subdir
+ names after the non-subdir names for each dir's contents, and it
+ always puts a dir's contents immediately after the dir's name in the
+ list. (Previously an item named "foo.txt" would sort in between
+ directory "foo/" and "foo/bar".)
+
+ - When talking to a protocol 29 rsync daemon, a list-only request
+ is able to note this before the options are sent over the wire and
+ the new --list-only option is included in the options.
+
+ - When the --stats bytes are sent over the wire (or stored in a batch),
+ they now include two elapsed-time values: one for how long it took to
+ build the file-list, and one for how long it took to send it over the
+ wire (each expressed in thousandths of a second).
+
+ - When --delete-excluded is specified with some filter excludes, a
+ client sender will now initiate a send of the filter rules to the
+ receiver (older protocols used to omit the sending of excludes in
+ this situation since there were no receiver-specific rules that
+ survived --delete-excluded back then). Note that, as with all the
+ filter-list sending, only items that are significant to the other
+ side will actually be sent over the wire, so the filter-rule list
+ is often empty in this scenario.
+
+ - A protocol-29 batch file includes a bit for the setting of the --dirs
+ option. Also, the shell script created by --write-batch will use the
+ --filter option instead of --exclude-from to capture any filter rules.
+
+ - An index equal to the file-list count is sent as a keep-alive packet
+ from the generator to the sender, who then forwards it on to the
+ receiver. This normally invalid index is only a valid keep-alive
+ packet if the 16-bit flag-word that follows it contains a single bit
+ (ITEM_IS_NEW, which is normally an illegal flag to appear alone).
BUILD CHANGES:
- - Added a "gen" target to rebuild most of the generated files,
- including configure, config.h.in, the man pages, and proto.h.
-
- - If "make proto" doesn't find some changes in the prototypes, the
- proto.h file is left untouched (its time-stamp used to always be
- updated).
-
- - The variable $STRIP (that is optionally set by the install-strip
- target's rule) was changed to $INSTALL_STRIP because some systems
- have $STRIP already set in the environment.
-
- - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
-
- - When cross-compiling, the gettimeofday() function is now assumed to
- be a modern version that takes two-args (since we can't test it).
-
- DEVELOPER RELATED:
-
- - The scripts in the testsuite dir were cleaned up a bit and a few
- new tests added.
-
- - Some new diffs were added to the patches dir, and some accepted
- ones were removed.
+ - Handle an operating system that use mkdev() in place of makedev().
+ - Improved configure to better handle cross-compiling.