Added "listen backlog" daemon config paramater.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index a24a953..5fd125a 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.1 (UNRELEASED)
-Protocol: 28 (changed)
-Changes since 2.6.0:
+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.)
+
+    - The --list-only option is now affected by the --human-readable setting.
+      It will display digit groupings by default, and unit suffixes if higher
+      levels of readability are requested.  Also, the column width for the size
+      output has increased from 11 to 14 characters when human readability is
+      enabled.  Use --no-h to get the old-style output and column size.
+
+    - 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 (a new line
+      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 that shows the counts by type.  The wording of the transferred count
+      has also changed so that it is clearer that it is only a count of regular
+      files.
 
-  ENHANCEMENTS:
+  BUG FIXES:
 
-    * Lower memory use and more optimal transfer of data over
-      the socket (see the INTERNAL section for details).
+    - 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 RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
+    - Fixed some rare bugs in --iconv processing that might cause a multibyte
+      character to get translated incorrectly.
 
-    * The --progress output now mentions how far along in the
-      transfer we are, including both a count of files transferred
-      and a percentage of the total file-count that we've processed.
-      It also shows better current-rate-of-transfer and remaining-
-      transfer-time values.
+    - 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.
 
-    * The configure script now accepts --with-rsyncd-conf=PATH
-      to override the default value of the /etc/rsyncd.conf file.
+  ENHANCEMENTS:
 
-    * Added a couple extra diffs in the "patches" dir, removed the
-      ones that got applied, and rebuilt the rest.
+    - 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.
 
-  BUG FIXES:
+    - 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 -x (--one-file-system) is combined with -L (--copy-links)
-      or --copy-unsafe-links, no symlinked files are skipped, even
-      if the referant file is on a different filesystem.
+    - 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 --link-dest code now works properly for a non-root user
-      when (1) the UIDs of the source and destination differ and -o
-      was specified, or (2) when the group of the source can't be
-      used on the destination and -g was specified.
+    - 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 -H (hard-links) that might
-      cause the expanded PATH/NAME value of the current item to
-      get overwritten (due to an expanded-name caching bug).
-      
-    * We now reset the "new data has been sent" flag at the start
-      of each file we send.  This makes sure that an interrupted
-      transfer with the --partial option set doesn't keep a shorter
-      temp file than the current basis file when no new data has been
-      transfered over the wire for that file.
+    - Added a "T" (terabyte) category to the --human-readable size suffixes.
 
-    * Fixed a byte-order problem in --batch-mode on big-endian
-      machines.  (Jay Fenlason)
+    - Added the --usermap/--groupmap/--chown options for manipulating file
+      ownership during the copy.
 
-    * Fixed configure bug when running "./configure --disable-ipv6".
+    - 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 "make test" bug when build dir is not the source dir.
+    - Added the "reverse lookup" parameter to the rsync daemon config file to
+      allow reverse-DNS lookups to be disabled.
 
-    * When using --cvs-exclude, the exclude items we get from a
-      directory's .cvsignore file once again only affect that one
-      directory (and not all following directories too).
+    - Added a forward-DNS lookup for the daemon's hosts allow/deny config.  Can
+      be disabled via "forward lookup" parameter (defaults to enabled).
 
-    * When specifying the USER@HOST: prefix for a file, the USER
-      part can now contain an '@', if needed (i.e. the last '@'
-      is used to find the HOST, not the first).
+    - 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.
 
-    * Fixed some bugs in the handling of group IDs for non-root
-      users:  (1) It properly handles a group that the sender didn't
-      have a name for (it would previously skip changing the group
-      on any files in that group).  (2) If --numeric-ids is used,
-      rsync no longer attempts to set groups that the user doesn't
-      have the permission to set.
+    - Added per-user authorization options and group-authorization support to
+      the daemon's "auth users" parameter.
 
-    * Fixed the "refuse options" setting in the rsyncd.conf file.
+    - Added a way to reference environment variables in a daemon's config file
+      (using %VAR% references).
 
-    * Improved the -x (--one-file-system) flag's handling of any
-      mount-point directories we encounter.  It is both more optimal
-      (in that it no longer does a useless scan of the contents of
-      the mount-point dirs) and also fixes a bug where a remaped
-      mount of the original filesystem could get discovered on a
-      disk we should be ignoring.
+    - When replacing a non-dir with a symlink/hard-link/device/special-file,
+      the update should now be done in an atomic manner.
 
-    * Rsync no longer discards a double-slash at the start of a filename
-      when trying to open the file.  It also no longer constructs names
-      that start with a double slash (unless the user supplied them).
+    - Fixed a free of the wrong pointer in uncache_tmp_xattrs() (which only
+      sometimes affects an --xattr transfer when --backup is used).
 
-    * Fixed compilation problem on Tru64 Unix (having to do with
-      sockaddr.sa_len and sockaddr.sin_len).
+    - 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.
 
-    * Fixed a compatibility problem interacting with older rsync
-      versions that might send us an empty suffix without telling us
-      about the backup-dir.
+    - Added the ability to synchronize nano-second modified times.
 
-    * The "hosts allow" option for a daemon-over-remote-shell
-      process now has improved support for IPv6 addresses and a fix
-      for systems that have a length field in their socket structs.
+    - Added a few more default suffixes for the "dont compress" settings.
 
-  INTERNAL:
-
-    * Most of the I/O is now buffered, which results in a pretty
-      large speedup when running under MS Windows.  (Craig Barratt)
+    - Added the checking of the RSYNC_PROTECT_ARGS environment variable to allow
+      the default for the --protect-args command-line option to be overridden.
 
-    * Optimizations to the name-handling/comparing code have made
-      some significant reductions in user-CPU time for large file
-      sets.
+    - Added some Solaris xattr code.
 
-    * Some variable-type cleanup that makes the code more consistent.
+  EXTRAS:
 
-    * Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - Added an "instant-rsyncd" script to the support directory, which makes
+      it easy to configure a simple rsync daemon in the current directory.
 
-    * Implemented a new algorithm for hard-link handling that speeds
-      up the code significantly.  (J.W. Schultz and Wayne Davison)
+    - 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.
 
-    * The --hard-link option now uses the first existing file in the
-      group of linked files as the basis for the transfer.  This
-      prevents the sub-optimal transfer of a file's data when a new
-      hardlink is added on the sending side and it sorts alphabetically
-      earlier in the list than the files that are already present on the
-      receiving side.
+  INTERNAL:
 
-    * Dropped support for protocol versions less than 20
-      (2.3.0 released 15 Mar 1999) and activated warnings for
-      protocols less than 25 (2.5.0 released 23 Aug 2001)
-          (Wayne Davison and J.W. Schultz, severally)
+    - 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).
 
-    * More optimal data transmission for --hard-links (protocol 28).
+    - 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.
 
-    * More optimal data transmission for --checksum (protocol 28).
+    - 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).
 
-    * Less memory is used when --checksum is specified.
+    - The filter code received some refactoring to make it more extendable, to
+      read better, and do better sanity checking.
 
-    * Less memory is used in the file list (a per-file savings).
+    - Really big numbers are now output using our own big-num routine rather
+      than casting them to a double and using a %.0f conversion.
 
-    * The generator is now better about not modifying the file list
-      during the transfer in order to avoid a copy-on-write memory
-      bifurcation (on systems where fork() uses shared memory).
-      Previously, rsync's shared memory would slowly become unshared,
-      resulting in real memory usage nearly doubling on the receiving
-      side by the end of the transfer.  Now, as long as permissions
-      are being preserved, the shared memory should remain that way
-      for the entire transfer.
+    - The pool_alloc library has received some minor improvements in alignment
+      handling.
 
-    * Changed hardlink info and file_struct + strings to use
-      allocation pools.  This reduces memory use for large
-      filesets and permits freeing memory to the OS.  (J.W. Schultz) 
+    - Added init_stat_x() function to avoid duplication of acl/xattr init code.
 
-    * The 2 pipes used between the receiver and generator processes
-      (which are forked on the same machine) were reduced to 1 pipe
-      and the protocol improved so that (1) it is now impossible to
-      have the "redo" pipe fill up and hang rsync, and (2) trailing
-      messages from the receiver don't get lost on their way through
-      the generator over to the sender (the latter mainly affected
-      hard-link messages and verbose --stats output).
+  DEVELOPER RELATED:
 
-    * The reading & writing of the file-list in batch-mode is now
-      handled by the same code that sends & receives the list over
-      the wire.  This makes it much easier to maintain.
+    - Added more conditional debug output.
 
-    * Improved the internal uid/gid code to be more portable and
-      a little more optimized.
+    - Changed configure.in to configure.ac.