X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/18ea5dc0d7fa5893b1edd3602ab77f0b09272342..da564b51a16259cfc22123ee5134fd7e6398ca1e:/NEWS diff --git a/NEWS b/NEWS index 4f1ce4a2..f45d762e 100644 --- a/NEWS +++ b/NEWS @@ -1,286 +1,223 @@ -NEWS for rsync 2.6.4 (UNRELEASED) -Protocol: 28 (unchanged) -Changes since 2.6.3: +NEWS for rsync 3.0.0 (UNRELEASED) +Protocol: 30 (changed) +Changes since 2.6.9: - 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 - setmode(fd, O_BINARY) called on the temp-file we opened with - mkstemp(). - - - 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: - - - The daemon-mode options were separated from the normal rsync options - so that they can't be mixed together. This makes it impossible for a - user to start a daemon that had improper default option values that - could cause problems (a hang or an exit) when a client connects. - - - 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. + NOTABLE CHANGE IN BEHAVIOR: - BUILD CHANGES: - - - Support an OS that uses mkdev() instead of makedev(). - - -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. + - 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 people who relied + upon having an implied dir be duplicated as a symlink, either specify + --keep-dirlinks or --no-implied-dirs. 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 the output of -ii when combined with one of the --*-dest options: + it now itemizes all the items, not just the changed ones. - - 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. + - Made the output of all file types consistent when using a --*-dest + option. Prior versions used to output too many creation events for + matching items. - - Got rid of a potential hang in the receiver when near the end of a - phase. + - 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. - - When using --backup without a --backup-dir, rsync no longer preserves - the modify time on directories. This avoids confusing NFS. + - A negated filter rule (with a '!' modifier) no longer loses the negation + when sending the filter rules to the remote rsync. - - 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". + - Fixed a problem with the --out-format (aka --log-format) option %f: it + would output superfluous directory information for a non-daemon rsync. - - 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. + - 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. - - 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). + - 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. - - 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). + - Make sure that directory permissions of a newly-created destination + directory are handled right when --perms is left off. - - Fixed a bug in the daemon authentication code when using one of the - batch-processing options. + - The itemized output of a newly-created destination directory is now + output as a creation event, not a change event. - - 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). + - Improved --hard-link so that more corner cases are handled correctly + when combined with options such as --link-dest and/or --ignore-existing. - - 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). + - The --append option no longer updates a file that has the same size. - - 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). + - Fixed a bug when combining --backup and --backup-dir with --inplace: + any missing backup directories are now created. - - 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. + - Fixed a bug when using --backup and --inplace with --whole-file or + --read-batch: backup files are actually created now. - - 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. + - Starting up an extra copy of an rsync daemon does not delete the pidfile + for the running daemon -- if the pidfile exists, the extra program will + exit with an error. - - 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 daemon pidfile is checked and created sooner in the startup sequence. 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. + - 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. + + - Saved memory 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 have an + empty hostname, as seen here: :file1 ::module/file2. This means that + local use of brace expansion now works: rsync -av host:path/{f1,f2} . + + - 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, patched versions of rsync, apply the acls.diff file from the patches + dir.) + + - Added the --xattrs (-X) option to preserver extended attributes. This is + an improved version of the prior patch that was available. (If you need + to have backward compatibility with old, 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. + There is also an analogous "fake super" option 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. + + - Added the --skip-compress=LIST option to override of the default list of + file suffixes that will not be compressed when using --compress. + + - The daemon's default for "dont compress" was extended to include: + *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg + The matching routine was also optimized to run more quickly. - - 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. + - 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.) - - 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). + - 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). - - Added the "write only" option for the daemon's config file. + - 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). - - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6) - and documented all these options in the man page. + - 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. - - Improved the handling of the --bwlimit option so that it's less - bursty, more accurate, and works properly over a larger range of - values. + - 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). - - 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. + - Protocol 30 now uses MD5 checksums instead of MD4. - - Added the --checksum-seed=N option for advanced users. + - If a daemon module's "path" value is not an absolute pathname, the code + now makes it absolute internally (making it work properly). - - 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. + - Changed the --append option to not checksum the existing data in the + destination file, which speeds up file appending. - - 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. + - 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. - - The daemon's "refuse options" config item now allows you to match - option names using wildcards and/or the single-letter option names. + - Documented and extended the support for the RSYNC_CONNECT_PROG variable + that can be used to enhance the client side of a daemon connection. - - 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 --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 ability to parse a literal IPv6 address in an "rsync:" URL - (e.g. rsync://[2001:638:500:101::21]:873/module/dir). + - Improved the dashes and double-quotes in the nroff manpage output. - - 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). + - We now support a lot more --no-OPTION override options. 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). + - 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 was also faster + than the glibc version of qsort() and mergesort() in my testing. - - Optimized the handling of larger block sizes (rsync used to slow to a - crawl if the block size got too large). + - Rsync now supports the transfer of 64-bit timestamps (time_t values). - - Optimized away a loop in hash_search(). + - Fixed a build problem with older (2.x) versions of gcc. - - 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). + - Added some isType() functions that make dealing with signed characters + easier without forcing variables via casts. - - 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. + - Changed strcat/strcpy/sprintf function calls to use safer versions. - - 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). + - Upgraded the included popt version to 1.10.2 and improved its use of + string-handling functions. - BUILD CHANGES: + - Added missing prototypes for compatibility functions from the lib dir. - - Added a "gen" target to rebuild most of the generated files, - including configure, config.h.in, the man pages, and proto.h. + - Configure determines if iconv() has a const arg, allowing us to avoid a + compiler warning. - - 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). + - Made the sending of some numbers more efficient for protocol 30. - - 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. + - Make sure that a daemon process doesn't mind if the client was weird and + omitted the --server option. - - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined. + - Improved the use of "const" on pointers. - - When cross-compiling, the gettimeofday() function is now assumed to - be a modern version that takes two-args (since we can't test it). + - Improved J.W.'s pool_alloc routines to add a way of freeing older + sections of a pool's memory. DEVELOPER RELATED: - - The scripts in the testsuite dir were cleaned up a bit and a few - new tests added. + - Rsync is now licensed under the GPLv3 or later. - - Some new diffs were added to the patches dir, and some accepted - ones were removed. + - 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, + and another file system does). + - Rsync now has a way of handling protocol-version changes during the + development of a new protocol version. This exchange of sub-version + info does not interfere with the {MIN,MAX}_PROTOCOL_VERSION checking + in older versions (since we'd quickly exceed the MAX_PROTOCOL_VERSION + if we incremented the main PROTOCOL_VERSION value for every minor + change during development).