X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/bd5b85dbc7b6d52c5af697c62c7a8412590ef46c..554dc122f271fc361b963067fa3d80084fd7ca91:/NEWS diff --git a/NEWS b/NEWS index dc81ce1a..4b38c7c1 100644 --- a/NEWS +++ b/NEWS @@ -1,278 +1,136 @@ -NEWS for rsync 2.6.4 (UNRELEASED) -Protocol: 29 (changed) -Changes since 2.6.3: +NEWS for rsync 3.1.0 (UNRELEASED) +Protocol: 31 (changed) +Changes since 3.0.4: 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. + - Output numbers in 3-digit groups by default (e.g. 1,234,567). See the + --human-readable option for a way to turn it off. See also the daemon's + "log format" parameter and related command-line options (including + --out-format) for a modifier that can be used to request digit-grouping + or human-readable output in log escapes. (Note that log output is + unchanged by default.) When some level of human-readable output is + enabled, the column width for the file size in the --list-only output + is increased. + + - The output of the --progress option has changed: the string "xfer" was + shortened to "xfr", and the string "to-check" was shortened to "to-chk", + both designed to make room for the (by default) wider display of file + size numbers without making the total line-length longer. Also, when + incremental recursion is enabled, the string "ir-chk" will be used + instead of "to-chk" up until the incremental-recursion scan is done, + letting you know that the value to check and the total value will still + be increasing as new files are found. + + - Enhanced the --stats output: 1) to mention how many files were created + (protocol >= 28), 2) to mention how many files were deleted (new for + protocol 31, but only output when --delete is in effect), and 3) to + follow the file-count, created-count, and deleted-count with a subcount + list broken down by type. - - 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.) - 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). + - Changed the way --progress overwrites its prior output in order to make + it nearly impossible for the progress to get overwritten by an error. - - The combination of --verbose and --dry-run now mentions changes in - directories and it now includes the full update information that - would be output without --dry-run at higher levels of verbosity. + - Fixed some rare bugs in --iconv processing that might cause a multibyte + character to get translated incorrectly. - - Avoid a mkdir warning when removing a directory in the destination - that already exists in the --backup-dir. + - Improved the propagation of abnormal-exit error messages. This should + help the client side to receive errors from the server when it is exiting + abnormally, and should also avoid dying with an "connection unexpectedly + closed" exit when the closed connection is really expected. - - 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(). (Fix derived from the cygwin's 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. - - - Fixed an off-by-one error in the handling of --max-delete=N. - - - One place in the code wasn't checking if fork() failed. - - - The "ignore nonreadable" daemon parameter no longer affects symlinks - that are being copied, even if they point nowhere. + ENHANCEMENTS: - - If the OS does not have lchown() and its chown() tries to set the - referent of a symlink (as it should), we no longer try to set the - user and group of a symlink. + - Added the --remote-option=OPT (-M OPT) command-line option that is useful + for things like sending a remote --log-file=FILE or --fake-super option. - - 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. + - Added the --info=FLAGS and --debug=FLAGS options to allow finer-grained + control over what is output. Added an extra type of --progress output + using --info=progress2. - - 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. + - The --msgs2stderr option can help with debugging rsync by allowing the + debug messages to get output to stderr rather than travel via the socket + protocol. - - One call to flush_write_file() was not being checked for an error. + - Added the --delete-missing-args and --ignore-missing-args options to + either delete or ignore user-specified files on the receiver that are + missing on the sender (normally the absence of user-specified files + generates an error). - - The --no-relative option was not being sent from the client to a - server sender. + - Added a "T" (terabyte) category to the --human-readable size suffixes. - - 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 (i.e. rsync might have - exited with an error for large files). + - Added the --usermap/--groupmap/--chown options for manipulating file + ownership during the copy. - - If a daemon can't open the specified log file (i.e. syslog is not - being used), die without crashing. We also try to output an error - about the failure (which will only be seen if --no-detach was - specified). + - Added the "%C" escape to the log-output handling, which will output the + MD5 checksum of any transferred file, or all files if --checksum was + specified (when protocol 30 or above is in effect). - - A local transfer no longer duplicates all its include/exclude options - by sending the forked process a copy of the list it already has. + - Added the "reverse lookup" parameter to the rsync daemon config file to + allow reverse-DNS lookups to be disabled. - ENHANCEMENTS: + - Added a way for more than one group to be specified in the daemon's + config file, including a way to specify that you want all of the + specified user's groups without having to name them. Also changed the + daemon to complain about an inability to set explicitly-specified uid/gid + values, even when not run by a super-user. - - Rsync now supports popt's option aliases, which means that you can - use /etc/popt and/or ~/.popt to create your own option aliases. - - - Added the --delete-during (--del) option which will delete files - from on the receiving side incrementally as each directory in the - transfer is being processed (which makes it more efficient than the - default, before-the-transfer behavior of --delete). Note that the - --del option is implemented as an internally-defined popt alias, so - an rsync daemon that refuses "delete" (which, for safety's sake, - really matches "delete*") will still refuse all delete options. The - default --delete behavior is also explicitly selectable via - --delete-before. - - - 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. - - - Added the --copy-dest option, which works like --link-dest except - that it includes copies of identical files. - - - Added support for specifying multiple --compare-dest, --copy-dest, or - --link-dest options, but only of a single type. (Promoted from the - patches dir and enhanced.) - - - Added the --max-size option. (Promoted from the patches dir.) - - - 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 (such as a hang or an abort) when a client connects. - - - 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. - - - 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. - - - 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 --inplace support was enhanced to work with --compare-dest, - --link-dest, and (the new) --copy-dest options. (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 - option kluges (e.g. the age-old use of "-r --exclude="/*/*" for a - non-recursive listing). This option is used automatically 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.) - - - 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 operate on a directory index (since - that would indicate that something had gone very wrong). - - - Added the --itemize-changes (-i) option that is a way to output the - list of files that got transferred and/or 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.) - - SUPPORT FILES: - - - Added support/atomic-rsync -- 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 support/mnt-excl 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 support/savetransfer.c -- 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 support/rrsync -- 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. - - - Improved the option descriptions in the --help text. + - Added a way to reference environment variables in a daemon's config file + (using %VAR% references). - INTERNAL: + - When replacing a non-dir with a symlink/hard-link/device/special-file, + the update should now be done in an atomic manner. - - Added better checking of the checksum-header values that come over - the socket. + - Fixed a free of the wrong pointer in uncache_tmp_xattrs() (which only + sometimes affects an --xattr transfer when --backup is used). - - Merged the various delete-file functions into a single function so - that it is easier to maintain. + - When backing up a file, try to hard-link the file into place so that the + upcoming replacement of the destination file will be atomic. - - Improved the type of some variables (particularly blocksize vars) for - consistency and proper size. + - Added the ability to synchronize nano-second modified times. - - Got rid of the uint64 type (which we didn't need). + - Added a few more default suffixes for the "dont compress" settings. - - Use a slightly more compatible set of core #include directives. + - Added the checking of the RSYNC_PROTECT_ARGS environment variable to allow + the default for the --protect-args command-line option to be overridden. - - Defined int32 in a way that ensures that the build dies if we can't - find a variable with at least 32 bits. + - Added some Solaris xattr code. - - 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. + EXTRAS: - PROTOCOL DIFFERENCES FOR VERSION 29: + - Added an "instant-rsyncd" script to the support directory, which makes + it easy to configure a simple rsync daemon in the current directory. - - 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 (only outputting local change messages - for older protocols). + - Added the "mapfrom" and "mapto" scripts to the support directory, which + makes it easier to do user/group mapping in a local transfer based on + passwd/group files from another machine. - - If --inplace is specified, the generator sends an extra byte after - the flag-word indicating what kind of basis file is being used for - the transfer (see the FNAMECMP_* defines). + INTERNAL: - - 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). + - The I/O code was rewritten to be simpler and do bigger buffered reads + over the socket. The I/O between the receiver and the generator was + changed to be standard multiplexed-I/O (like that over the socket). - - 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".) + - The sender tries to use any dead time while the generator is looking for + files to transfer in order to do sender-side directory scanning in a more + parallel manner. - - 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 enabled. + - A daemon can now inform a client about a daemon-configured timeout value + so that the client can assist in the keep-alive activity (protocol 31). - - 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). + - The filter code received some refactoring to make it more extendable, to + read better, and do better sanity checking. - - When --delete-excluded is specified with some filter rules (AKA - excludes), a client sender will still initiate a send of the filter - rules to the receiver, but it only includes those rules that are - receiver-specific. 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). + - Really big numbers are now output using our own big-num routine rather + than casting them to a double and using a %.0f conversion. - - 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. + - The pool_alloc library has received some minor improvements in alignment + handling. - BUILD CHANGES: + - Added init_stat_x() function to avoid duplication of acl/xattr init code. - - Handle an operating system that use mkdev() in place of makedev(). + DEVELOPER RELATED: - - Improved configure to better handle cross-compiling. + - Added more conditional debug output.