Removing now-redundant path-size check from send_if_directory().
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index fe78a99..4b38c7c 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.9 (6 Nov 2006)
-Protocol: 29 (unchanged)
-Changes since 2.6.8:
+NEWS for rsync 3.1.0 (UNRELEASED)
+Protocol: 31 (changed)
+Changes since 3.0.4:
+
+  OUTPUT CHANGES:
+
+    - 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.
 
   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.
+    - Changed the way --progress overwrites its prior output in order to make
+      it nearly impossible for the progress to get overwritten by an error.
 
-    - 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.
+    - Fixed some rare bugs in --iconv processing that might cause a multibyte
+      character to get translated incorrectly.
 
-    - 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.)
+    - 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.
 
-    - 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.
-
-    - 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.
+  ENHANCEMENTS:
 
-    - 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).
+    - 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.
 
-    - If the receiving side fails to create a directory, it will now skip
-      trying to update everything that is inside that directory.
+    - 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.
 
-    - 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.
+    - 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.
 
-    - 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).
+    - 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).
 
-    - 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.
+    - Added a "T" (terabyte) category to the --human-readable size suffixes.
 
-    - 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).
+    - Added the --usermap/--groupmap/--chown options for manipulating file
+      ownership during the copy.
 
-    - Fixed a recent bug where --delete was not working when transferring from
-      the root (/) of the filesystem with --relative enabled.
+    - 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).
 
-    - Fixed a recent bug where an --exclude='*' could affect the root (/) of
-      the filesystem with --relative enabled.
+    - Added the "reverse lookup" parameter to the rsync daemon config file to
+      allow reverse-DNS lookups to be disabled.
 
-    - 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).
+    - 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.
 
-    - 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.
+    - Added a way to reference environment variables in a daemon's config file
+      (using %VAR% references).
 
-    - Fixed a bug in the daemon's "incoming chmod" rule:  newly-created
-      directories no longer get the 'F' (file) rules applied to them.
+    - When replacing a non-dir with a symlink/hard-link/device/special-file,
+      the update should now be done in an atomic manner.
 
-    - Fixed an infinite loop bug when a filter rule was rejected due to being
-      overly long.
+    - Fixed a free of the wrong pointer in uncache_tmp_xattrs() (which only
+      sometimes affects an --xattr transfer when --backup is used).
 
-    - 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).
+    - 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.
 
-  ENHANCEMENTS:
+    - Added the ability to synchronize nano-second modified times.
 
-    - 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.
+    - Added a few more default suffixes for the "dont compress" settings.
 
-    - 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.)
+    - Added the checking of the RSYNC_PROTECT_ARGS environment variable to allow
+      the default for the --protect-args command-line option to be overridden.
 
-    - Made "log file" and "syslog facility" settable on a per-module basis in
-      the daemon's config file.
+    - Added some Solaris xattr code.
 
-    - 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.)
+  EXTRAS:
 
-    - 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.)
+    - Added an "instant-rsyncd" script to the support directory, which makes
+      it easy to configure a simple rsync daemon in the current directory.
 
-    - 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.
+    - 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.
 
   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 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).
 
-    - Fixed a potential bug in f_name_cmp() when both the args are a
-      top-level "." dir (which doesn't happen in normal operations).
+    - 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.
 
-    - 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.
+    - 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).
 
-    - The macro WIFEXITED(stat) will now be defined if the OS didn't already
-      define it.
+    - The filter code received some refactoring to make it more extendable, to
+      read better, and do better sanity checking.
 
-  DEVELOPER RELATED:
-
-    - 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.
+    - 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 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).
+    - The pool_alloc library has received some minor improvements in alignment
+      handling.
 
-    - The rsync.yo and rsyncd.conf.yo files have been updated to work
-      better with the latest yodl 2.x releases.
+    - Added init_stat_x() function to avoid duplication of acl/xattr init code.
 
-    - Updated config.guess and config.sub to their 2006-02-23 version.
+  DEVELOPER RELATED:
 
-    - Updated various files to include the latest FSF address and to have
-      consistent opening comments.
+    - Added more conditional debug output.