Removing now-redundant path-size check from send_if_directory().
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 474b7be..4b38c7c 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.5 (UNRELEASED)
-Protocol: 29 (unchanged)
-Changes since 2.6.4:
+NEWS for rsync 3.1.0 (UNRELEASED)
+Protocol: 31 (changed)
+Changes since 3.0.4:
 
   OUTPUT CHANGES:
 
-    - Non-printable chars in filenames are now output using backslash-
-      escaped characters rather than '?'s.  Any non-printable character is
-      output using 3 digits of octal (e.g. "\n" -> "\012"), and a backslash
-      is now output as "\\".  Rsync also uses your locale setting, which
-      can make it treat fewer high-bit characters as non-printable.
-
-    - If rsync received an empty file list when pulling files, it would
-      output a "nothing to do" message and exit with a 0 (success) exit
-      status, even if the remote rsync returned an error (it did not do
-      this under the same conditions when pushing files).  This was changed
-      to make the pulling behavior the same as the pushing behavior:  we
-      now do the normal end-of-run outputting (depending on options) and
-      exit with the appropriate exit status.
+    - 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:
 
-    - A crash bug was fixed when a daemon had its "path" set to "/", did
-      not have chroot enabled, and used some anchored excludes in the
-      rsyncd.conf file.
-
-    - Fixed a bug in the transfer of a single file when -H is specified
-      that might have caused an infinite loop or perhaps a crash.
-
-    - Fixed a case where the generator might try to tweak the write
-      permissions of a read-only directory in list-only mode.
-
-    - If --compare-dest or --link-dest uses a locally-copied file as the
-      basis for an updated version, log this better when --verbose or -i
-      is in effect.
-
-    - Fixed the accidental disabling of --backup during the --delete-after
-      processing.
+    - Changed the way --progress overwrites its prior output in order to make
+      it nearly impossible for the progress to get overwritten by an error.
 
-    - Restored the ability to use the --address option in client mode (in
-      addition to its use in daemon mode).
+    - Fixed some rare bugs in --iconv processing that might cause a multibyte
+      character to get translated incorrectly.
 
-    - Make sure that some temporary progress information from the delete
-      processing does not get left on the screen when it is followed by a
-      newline.
+    - 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.
 
-    - When --existing skips a directory with extra verbosity, refer to it
-      as a "directory", not a "file".
-
-    - When transferring a single file to a different-named file, any
-      generator messages that are source-file related no longer refer to
-      the file by the destination filename.
+  ENHANCEMENTS:
 
-    - Fixed a bug where hard-linking a group of files might fail if the
-      generator hasn't created a needed destination directory yet.
+    - 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.
 
-    - Fixed a bug where a hard-linked group of files that is newly-linked
-      to a file in a --link-dest dir doesn't link the files from the rest
-      of the cluster.
+    - 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 deleting files with the --one-file-system (-x) option set, rsync
-      no longer tries to remove files from inside a mount-point on the
-      receiving side.
+    - 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.
 
-    - Fixed a compatibility problem when using --cvs-ignore (-C) and
-      sending files to an older rsync without using --delete.
+    - 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).
 
-    - Make sure that a "- !" or "+ !" include/exclude pattern does not
-      trigger the list-clearing action that is reserved for "!".
+    - Added a "T" (terabyte) category to the --human-readable size suffixes.
 
-    - Avoid a timeout in the generator when the sender/receiver aren't
-      handling the generator's checksum output quickly enough.
+    - Added the --usermap/--groupmap/--chown options for manipulating file
+      ownership during the copy.
 
-    - Fixed the ommission of some directories in the delete processing when
-      --relative (-R) was combined with a source path that had a trailing
-      slash.
+    - 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).
 
-    - Make sure that --max-size doesn't affect a device or a symlink.
+    - Added the "reverse lookup" parameter to the rsync daemon config file to
+      allow reverse-DNS lookups to be disabled.
 
-    - Make sure that a system with a really small MAXPATHLEN does not cause
-      the buffers in readfd_unbuffered() to be too small to receive normal
-      messages.  (This mainly affected Cygwin.)
+    - 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 a source filename ends with "..", treat it as if "../" had been
-      specified (so that we don't copy files to the parent dir of the
-      destination).
+    - Added a way to reference environment variables in a daemon's config file
+      (using %VAR% references).
 
-    - If --delete is combined with a file-listing rsync command (i.e. no
-      transfer is happening), avoid outputting a warning that we couldn't
-      delete anything.
+    - When replacing a non-dir with a symlink/hard-link/device/special-file,
+      the update should now be done in an atomic manner.
 
-    - If --stats is specified with --delete-after, ensure that all the
-      "deleting" messages are output before the statistics.
+    - Fixed a free of the wrong pointer in uncache_tmp_xattrs() (which only
+      sometimes affects an --xattr transfer when --backup is used).
 
-  ENHANCEMENTS:
+    - 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.
 
-    - Added the --only-write-batch=FILE option that may be used (instead
-      of --write-batch=FILE) to create a batch file without doing any
-      actual updating of the destination.  This allows you to divert all
-      the file-updating data away from a slow data link (as long as you
-      are pushing the data to the remote server when creating the batch).
+    - Added the ability to synchronize nano-second modified times.
 
-    - When the generator is taking a long time to fill up its output buffer
-      (e.g. if the transferred files are few, small, or missing), it now
-      periodically flushes the output buffer so that the sender/receiver
-      can get started on the files sooner rather than later.
+    - Added a few more default suffixes for the "dont compress" settings.
 
-    - Improved the auth-errors that are logged by the daemon to include
-      some information on why the authorization failed (wrong user,
-      password mismatch, etc.).  (The client-visible message is unchanged.)
+    - Added the checking of the RSYNC_PROTECT_ARGS environment variable to allow
+      the default for the --protect-args command-line option to be overridden.
 
-    - Improved the client's handling of an "@ERROR" from a daemon so that
-      it does not complain about an unexpectedly closed socket (since we
-      really did expect the socket to close).
+    - Added some Solaris xattr code.
 
-    - If the daemon can't open the log-file specified in rsyncd.conf, fall
-      back to using syslog (and log an appropriate warning).  This is
-      better than what was typically a totally silent failure (since a
-      daemon is not usually run with the --no-detach option that was
-      necessary to see the error on stderr).
+  EXTRAS:
 
-    - The man pages now consistently refer to an rsync daemon as a "daemon"
-      to distinguish it from a server in a non-daemon transfer.
+    - Added an "instant-rsyncd" script to the support directory, which makes
+      it easy to configure a simple rsync daemon in the current directory.
 
-    - Made a small change to the rrsync script (restricted rsync -- in the
-      support dir) to make a read-only server reject all --remove-* options
-      when sending files (to future-proof it against the possibility of
-      other similar options being added at some point).
+    - 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:
 
-    - Rsync now calls setlocale(LC_CTYPE, "") to enable isprint() to better
-      discern which filename characters need to be escaped in messages.
-
-    - Improved the naming of the log-file open/reopen/close functions.
+    - 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).
 
-    - Removed some protocol compatibility code that was only needed to help
-      someone running a pre-release of 2.6.4.
+    - 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.
 
-  BUILD CHANGES:
+    - 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).
 
-    - Fixed a bug in the SUPPORT{,_HARD}_LINKS defines which prevented
-      rsync from being built without symlink or hard-link support.
+    - The filter code received some refactoring to make it more extendable, to
+      read better, and do better sanity checking.
 
-    - You can use --disable-locale to turn off any use of setlocale().
+    - Really big numbers are now output using our own big-num routine rather
+      than casting them to a double and using a %.0f conversion.
 
-    - Configure now disables the use of mkstemp() under HP-UX (since they
-      refuse to fix its broken handling of large files).
+    - The pool_alloc library has received some minor improvements in alignment
+      handling.
 
-    - Configure now explicitly checks for the lseek64() function so that
-      the code can use HAVE_LSEEK64 instead of inferring lseek64()'s
-      presence based on the presence of the off64_t type.
+    - Added init_stat_x() function to avoid duplication of acl/xattr init code.
 
-    - Some minor enhancements to the test scripts.
+  DEVELOPER RELATED:
 
-    - Added a few new diffs to the patches dir, including a patch that
-      enables the optional copying of extended attributes.
+    - Added more conditional debug output.