Preparing for release of 3.1.0
[rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 135932ffa2da0b66183ca291a28dacd193563bcf..3ee18a51e2497ff9c1130d80370132ae31ae524a 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 3.0.0 (UNRELEASED)
-Protocol: 30 (changed)
-Changes since 2.6.9:
-
-  NOTABLE CHANGES IN BEHAVIOR:
-
-    - The handling of implied directories when using --relative has changed to
-      send them as directories (e.g. no implied dir is ever sent as a symlink).
-      This avoids unexpected behavior and should not adversely affect most
-      people.  If you're one of those rare individuals who relied upon having
-      an implied dir be duplicated as a symlink, you should specify the
-      transfer of the symlink and the transfer of the referent directory as
-      separate args.  (See also --keep-dirlinks and --no-implied-dirs.)
-
-    - Requesting a remote file list without specifying -r (--recursive) now
-      sends the -d (--dirs) option to the remote rsync rather than sending -r
-      along with an extra exclude of /*/*.  If the remote rsync does not
-      understand the -d option (i.e. it is 2.6.3 or older), you will need to
-      either turn off -d (--no-d), or specify  -r --exclude='/*/*'  manually.
+NEWS for rsync 3.1.0 (28 Sep 2013)
+Protocol: 31 (changed)
+Changes since 3.0.9:
+
+  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.
+    - Fixed a bug in the iconv code when EINVAL or EILSEQ is returned with a
+      full output buffer.
 
-    - Made the output of all file types consistent when using a --*-dest
-      option.  Prior versions would 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.
+    - Fixed a bogus "vanished file" error if some files were specified with
+      "./" prefixes and others were not.
 
-    - A negated filter rule (i.e. with a '!' modifier) no longer loses the
-      negation when sending the filter rules to the remote rsync.
+    - Fixed a bug in --sparse where an extra gap could get inserted after a
+      partial write.
 
-    - Fixed a problem with the --out-format (aka --log-format) option %f:  it
-      no longer outputs superfluous directory info for a non-daemon rsync.
+    - 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 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.
+    - 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.
 
-    - 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 sender now checks each file it plans to remove to ensure that it
+      hasn't changed from the first stat's info.  This helps to avoid losing
+      file data when the user is not using the option in a safe manner.
 
-    - Make sure that directory permissions of a newly-created destination
-      directory are handled right when --perms is left off.
+    - Fixed a data-duplication bug in the compress option that made compression
+      less efficient.  This improves protocol 31 onward, while behaving in a
+      compatible (buggy) manner with older rsync protocols.
 
-    - The itemized output of a newly-created destination directory is now
-      output as a creation event, not a change event.
+    - When creating a temp-file, rsync is now a bit smarter about it dot-char
+      choices, which can fix a problem on OS X with names that start with "..".
 
-    - Improved --hard-link so that more corner cases are handled correctly
-      when combined with options such as --link-dest and/or --ignore-existing.
+    - Rsync now sets a cleanup flag for --inplace and --append transfers that
+      will flush the write buffer if the transfer aborts.  This ensures that
+      more received data gets written out to the disk on an aborted transfer
+      (which is quite helpful on a slow, flaky connection).
 
-    - The --append option no longer updates a file that has the same size.
+    - The reads that map_ptr() now does are aligned on 1K boundaries.  This
+      helps some filesystems and/or files that don't like unaligned reads.
 
-    - Fixed a bug when combining --backup and --backup-dir with --inplace:
-      any missing backup directories are now created.
+    - Fix an issue in the msleep() function if time jumps backwards.
 
-    - Fixed a bug when using --backup and --inplace with --whole-file or
-      --read-batch: backup files are actually created now.
+    - Fix daemon-server module-name splitting bug where an arg would get split
+      even if --protect-args was used.
 
-    - Starting up an extra copy of an rsync daemon will not clobber the pidfile
-      for the running daemon -- if the pidfile exists, the new daemon will exit
-      with an error.
+  ENHANCEMENTS:
 
-    - The daemon pidfile is checked and created sooner in the startup sequence.
+    - 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 a daemon module's "path" value is not an absolute pathname, the code
-      now makes it absolute internally (making it work properly).
+    - 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.
 
-    - Ensure that a temporary file always has owner-write permission while we
-      are writing to it.  This avoids problems with some network filesystems.
+    - 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.
 
-    - Any errors output about password-file reading no longer cause an error at
-      the end of the run about a partial transfer.
+    - 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.x 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.
-
-    - Lowered memory use in the non-incremental-recursion algorithm for typical
-      option values (usually saving from 21-29 bytes per file).
-
-    - 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.
-
-    - Rsync now allows multiple remote-source args to be specified rather than
-      having to rely on a special space-splitting side-effect of the remote-
-      shell.  Additional remote args must specify the same host or an empty one
-      (e.g. empty:  :file1  or  ::module/file2).  This means that local use of
-      brace expansion now works:  rsync -av host:dir/{f1,f2} .
-
-    - Added the --protect-args (-s) option, that tells rsync to send most of
-      the command-line args at the start of the transfer rather than as args
-      to the remote-shell command.  This protects them from space-splitting,
-      and only interprets basic wildcard special shell characters (*?[).
-
-    - 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, and it even
-      supports OS X ACLs.  If you need to have backward compatibility with old,
-      acl-patched versions of rsync, apply the acls.diff file from the patches
-      dir.
-
-    - Added the --xattrs (-X) option to preserver extended attributes.  This is
-      an improved version of the prior patch that was available, and it even
-      supports OS X xattrs (which includes their resource fork data).  If you
-      need to have backward compatibility with old, xattr-patched versions of
-      rsync, apply the xattrs.diff file from the patches dir.
-
-    - 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.
-      It even supports the storing of foreign ACL data on your backup server.
-      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 then
-      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 manpage for an
-      explanation of the --iconv option's settings.
-
-    - Added the --skip-compress=LIST option to override the default list of
-      file suffixes that will not be compressed when using --compress.
-      
-    - The daemon's default for "dont compress" was extended to include:
-         *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
-      The matching routine was also optimized to run more quickly.
-
-    - The --max-delete option now outputs a warning if it skipped any file
-      deletions, including a count of how many deletions were skipped.  (Older
-      versions just silently stopped deleting things.)
-
-    - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
-      about extraneous files without deleting anything.  If you're not sure
-      what version the client is, you can use the less-obvious --max-delete=-1,
-      as both old and new versions will treat that as the same request (though
-      older versions don't warn).
-
-    - 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).
-
-    - The filter rules now support a perishable ("p") modifier that marks rules
-      that should not have an effect in a directory that is being deleted.  e.g.
-      -f '-p .svn/' would only affect "live" .svn directories.
-
-    - If we get an error setting the time on a symlink, we don't complain about
-      it anymore (since some operating systems don't support that, and it's not
-      that important).
-
-    - Protocol 30 now uses MD5 checksums instead of MD4.
-
-    - Changed the --append option to not checksum the existing data in the
-      destination file, which speeds up file appending.
-
-    - Added the --append-verify option, which works like the older --append
-      option (verifying the existing data in the destination file).  For
-      compatibility with older rsync versions, any use of --append that is
-      talking protocol 29 or older will revert to the --append-verify method.
-
-    - Documented and extended the support for the RSYNC_CONNECT_PROG variable
-      that can be used to enhance the client side of a daemon connection.
-
-    - Improved the dashes and double-quotes in the nroff manpage output.
-
-    - We now support a lot more --no-OPTION override options.
+    - 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.
+
+    - The daemon now tries to send the user the error messages from the
+      pre-xfer exec script when it fails.
+
+    - Improved the use of alt-dest options into an existing hierarchy of files:
+      If a match is found in an alt-dir, it takes precedence over an existing
+      file.  (We'll need to wait for a future version before attribute-changes
+      on otherwise unchanged files are safe when using an existing hierarchy.)
+
+    - 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).
+
+    - When replacing a non-dir with a symlink/hard-link/device/special-file,
+      the update should now be done in an atomic manner.
+
+    - Avoid re-sending xattr info for hard-linked files w/the same xattrs
+      (protocol 31).
+
+    - The backup code was improved to use better logic maintaining the backup
+      directory hierarchy.  Also, when a file is being backed up, rsync tries
+      to hard-link it into place so that the upcoming replacement of the
+      destination file will be atomic (for the normal, non-inplace logic).
+
+    - 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.
 
-    - 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.
+    - Added the --preallocate command-line option.
 
-    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
+    - Allow --password-file=- to read the password from stdin (filename "-").
 
-    - Fixed a build problem with older (2.x) versions of gcc.
+    - Rsync now comes packaged with an rsync-ssl helper script that can be
+      used to contact a remote rsync daemon using a piped-stunnel command.
+      It also includes an stunnel config file to run the server side to
+      support ssl daemon connections.  See the packaging/lsb/rsync.spec
+      file for one way to package the resulting files.  (Suggestions for
+      how to make this even easier to install & use are welcomed.)
 
-    - Added some isType() functions that make dealing with signed characters
-      easier without forcing variables via casts.
+    - Improved the speed of some --inplace updates when there are lots of
+      identical checksum blocks that end up being unusable.
 
-    - Changed strcat/strcpy/sprintf function calls to use safer versions.
+    - Added the --outbuf=N|L|B option for choosing the output buffering.
 
-    - Upgraded the included popt version to 1.10.2 and improved its use of
-      string-handling functions.
+    - Repeating the --fuzzy option now causes the code to look for fuzzy
+      matches inside alt-dest directories too.
 
-    - Added missing prototypes for compatibility functions from the lib dir.
+    - The --chmod option now supports numeric modes, e.g. --chmod=644,D755
 
-    - Configure determines if iconv() has a const arg, allowing us to avoid a
-      compiler warning.
+    - Added some Solaris xattr code.
 
-    - Made the sending of some numbers more efficient for protocol 30.
+    - Made an rsync daemon (the listening process) exit with a 0 status when
+      it was signaled to die.  This helps launchd.
 
-    - Make sure that a daemon process doesn't mind if the client was weird and
-      omitted the --server option.
+    - Improved the RSYNC_* environment variables for the pre-xfer exec script:
+      when a daemon is sent multiple request args, they are now joined into a
+      single return value (separated by spaces) so that the RSYNC_REQUEST
+      environment variable is accurate for any "pre-xfer exec".  The values in
+      RSYNC_ARG# vars are no longer truncated at the "." arg (prior to the
+      request dirs/files), so that all the requested values are also listed
+      (separately) in RSYNC_ARG# variables.
 
-    - Improved the use of "const" on pointers.
+  EXTRAS:
 
-    - Improved J.W.'s pool_alloc routines to add a way of freeing older
-      sections of a pool's memory.
+    - Added an "instant-rsyncd" script to the support directory, which makes
+      it easy to configure a simple rsync daemon in the current directory.
 
-    - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
-      some new code (derived from samba, derived from PostgreSQL) that has a
-      better license than the old code.
+    - 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.
+
+    - There's a new, improved version of the lsh script in the support dir:
+      it's written in perl and supports -u without resorting to using sudo
+      (when run as root).  The old shell version is now named lsh.sh.
+
+    - There is a helper script named rsync-slash-strip in the support directory
+      for anyone that wants to change the way rsync handles args with trailing
+      slashes.  (e.g. arg/ would get stripped to arg while arg/. would turn into
+      arg/).
+
+  INTERNAL:
+
+    - 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).
+
+    - 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.
+
+    - 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 filter code received some refactoring to make it more extendible, to
+      read better, and do better sanity checking.
+
+    - 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 pool_alloc library has received some minor improvements in alignment
+      handling.
+
+    - Added init_stat_x() function to avoid duplication of acl/xattr init code.
+
+    - The included zlib was upgraded from 1.2.3 to 1.2.8.
+
+    - Rsync can now be compiled to use an unmodified zlib library instead of
+      the tweaked one that is included with rsync.  This will eventually
+      become the default, at which point we'll start the countdown to removing
+      the included zlib.  Until then, feel free to configure using:
+
+       ./configure --with-included-zlib=no
 
   DEVELOPER RELATED:
 
-    - Rsync is now licensed under the GPLv3 or later.
-
-    - When running the tests, we now put our per-test temp dirs into a sub-
-      directory named testtmp (which is created, if missing).  This allows
-      someone to symlink the testtmp directory to another filesystem (which is
-      useful if the build dir's filesystem does not support ACLs and xattrs,
-      but another file system does).
-
-    - Rsync now has a way of handling protocol-version changes during the
-      development of a new protocol version.  This causes any out-of-sync
-      versions to speak an older protocol rather than fail in a cryptic manner.
-      This addition makes it safe to deploy a pre-release version that may
-      interact with the public.  This new exchange of sub-version info does not
-      interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
-      does not have enough range to allow the main protocol number to be
-      incremented for every minor tweak in that happens during development).
+    - Added more conditional debug output.
+
+    - Fixed some build issues for android and minix.