Improve the &merge/&include example explanation.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index ea015f4..5fd125a 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 3.0.0 (UNRELEASED)
-Protocol: 30 (changed)
-Changes since 2.6.9:
+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.
 
   BUG FIXES:
 
-    - Fixed the output of -ii when combined with one of the --*-dest options:
-      it now itemizes all the items, not just the changed ones.
+    - Changed the way --progress overwrites its prior output in order to make
+      it nearly impossible for the progress to get overwritten by an error.
 
-    - 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.
+    - Fixed some rare bugs in --iconv processing that might cause a multibyte
+      character to get translated incorrectly.
 
-    - 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.
+    - 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.
 
-    - A negated filter rule now sends the negation option when sending the
-      filter rules.
+  ENHANCEMENTS:
 
-    - Fixed a problem with the --out-format (aka --log-format) option:  it
-      would output superfluous directory information for a non-daemon rsync.
+    - 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 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.
+    - 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 --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.
+    - 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.
 
-    - Make sure that directory permissions of a newly-created destination
-      directory are handled right when --perms is left off.
+    - 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).
 
-  ENHANCEMENTS:
+    - Added a "T" (terabyte) category to the --human-readable size suffixes.
 
-    - A new incremental-recursion algorithm is now used when rsync is talking
-      to another 3.0.0 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.
-
-    - 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.
-
-    - 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.  (If you need
-      to have backward compatibility with old, patched versions, the new
-      acls.diff patch that will add that.)
-
-    - 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, the new
-      xattrs.diff patch that will add that.)
-
-    - 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 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 man page for an explanation of the --iconv
-      option's settings.
-
-    - You may specify --max-delete=0 to a 3.0.0 client as long as the receiving
-      side is at least version 3.0.0.  This means that you can pull from an
-      older rsync with this option, but pushing to an older rsync will generate
-      an error.  *Be sure to never specify a 0 value to an older rsync client,
-      or it will be silently ignored.*
-
-    - 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).
-
-    - A lot more --no-OPTION override options are now supported.
+    - Added the --usermap/--groupmap/--chown options for manipulating file
+      ownership during the copy.
 
-  INTERNAL:
+    - 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).
+
+    - Added the "reverse lookup" parameter to the rsync daemon config file to
+      allow reverse-DNS lookups to be disabled.
+
+    - Added a forward-DNS lookup for the daemon's hosts allow/deny config.  Can
+      be disabled via "forward lookup" parameter (defaults to enabled).
+
+    - 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.
+
+    - Added per-user authorization options and group-authorization support to
+      the daemon's "auth users" parameter.
+
+    - Added a way to reference environment variables in a daemon's config file
+      (using %VAR% references).
 
-    - 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.
+    - When replacing a non-dir with a symlink/hard-link/device/special-file,
+      the update should now be done in an atomic manner.
 
-    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
+    - Fixed a free of the wrong pointer in uncache_tmp_xattrs() (which only
+      sometimes affects an --xattr transfer when --backup is used).
 
-    - Fixed a build problem with older (2.x) versions of gcc.
+    - 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 some isType() functions that make dealing with signed characters
-      easier without forcing variables via casts.
+    - Added the ability to synchronize nano-second modified times.
+
+    - Added a few more default suffixes for the "dont compress" settings.
+
+    - Added the checking of the RSYNC_PROTECT_ARGS environment variable to allow
+      the default for the --protect-args command-line option to be overridden.
+
+    - Added some Solaris xattr code.
+
+  EXTRAS:
+
+    - Added an "instant-rsyncd" script to the support directory, which makes
+      it easy to configure a simple rsync daemon in the current directory.
+
+    - 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:
 
-    - Upgraded the included popt version to 1.10.2 and improved its use of
-      string-handling 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).
 
-    - Added missing prototypes for compatibility functions from the lib dir.
+    - 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.
 
-    - Configure determines if iconv() has a const arg, allowing us to avoid a
-      compiler warning.
+    - 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).
 
-    - Made the sending of some numbers more efficient for protocol 30.
+    - The filter code received some refactoring to make it more extendable, to
+      read better, and do better sanity checking.
 
-    - Make sure that a daemon process doesn't mind if the client was weird and
-      omitted the --server option.
+    - Really big numbers are now output using our own big-num routine rather
+      than casting them to a double and using a %.0f conversion.
 
-    - Improved the use of "const" on pointers.
+    - The pool_alloc library has received some minor improvements in alignment
+      handling.
 
-    - Improved J.W.'s pool_alloc routines to add a way of freeing older
-      sections of a pool's memory.
+    - Added init_stat_x() function to avoid duplication of acl/xattr init code.
 
   DEVELOPER RELATED:
 
-    - Rsync is now licensed under the GPLv3 or later.
+    - Added more conditional debug output.
 
-    - 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 (which would be the case if every minor change made
-      to the protocol in CVS incremented the main PROTOCOL_VERSION value).
+    - Changed configure.in to configure.ac.