Preparing for release of 3.0.0pre1
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index fe684a1..f45d762 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.0.0 (UNRELEASED)
+Protocol: 30 (changed)
+Changes since 2.6.9:
 
-  ENHANCEMENTS:
+  NOTABLE CHANGE IN BEHAVIOR:
 
-    * Lower memory use and more optimal transfer of data over
-      the socket (see the INTERNAL section for details).
+   - 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 people who relied
+     upon having an implied dir be duplicated as a symlink, either specify
+     --keep-dirlinks or --no-implied-dirs.
 
-    * The RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
+  BUG FIXES:
 
-    * 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.
+    - Fixed the output of -ii when combined with one of the --*-dest options:
+      it now itemizes all the items, not just the changed ones.
 
-    * The configure script now accepts --with-rsyncd-conf=PATH
-      to override the default value of the /etc/rsyncd.conf file.
+    - 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.
 
-    * Added a couple extra diffs in the "patches" dir, removed the
-      ones that got applied, and rebuilt the rest.
+    - 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.
 
-  BUG FIXES:
+    - A negated filter rule (with a '!' modifier) no longer loses the negation
+      when sending the filter rules to the remote rsync.
+
+    - Fixed a problem with the --out-format (aka --log-format) option %f:  it
+      would output superfluous directory information for a non-daemon rsync.
+
+    - 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.
+
+    - 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.
+
+    - Make sure that directory permissions of a newly-created destination
+      directory are handled right when --perms is left off.
+
+    - The itemized output of a newly-created destination directory is now
+      output as a creation event, not a change event.
+
+    - Improved --hard-link so that more corner cases are handled correctly
+      when combined with options such as --link-dest and/or --ignore-existing.
 
-    * 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 --append option no longer updates a file that has the same size.
 
-    * 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.
+    - Fixed a bug when combining --backup and --backup-dir with --inplace:
+      any missing backup directories are now created.
 
-    * 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).
+    - Fixed a bug when using --backup and --inplace with --whole-file or
+      --read-batch: backup files are actually created now.
+
+    - Starting up an extra copy of an rsync daemon does not delete the pidfile
+      for the running daemon -- if the pidfile exists, the extra program will
+      exit with an error.
+
+    - The daemon pidfile is checked and created sooner in the startup sequence.
+
+  ENHANCEMENTS:
+
+    - 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.
+
+    - Saved memory 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 have an
+      empty hostname, as seen here:  :file1  ::module/file2.  This means that
+      local use of brace expansion now works:  rsync -av host:path/{f1,f2} .
+
+    - 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, 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.  (If you need
+      to have backward compatibility with old, 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.
+      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 of the default list of
+      file suffixes that will not be compressed when using --compress.
       
-    * 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.
+    - 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).
 
-    * Fixed a byte-order problem in --batch-mode on big-endian
-      machines.  (Jay Fenlason)
+    - 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.
 
-    * Fixed configure bug when running "./configure --disable-ipv6".
+    - 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).
 
-    * Fixed "make test" bug when build dir is not the source dir.
+    - Protocol 30 now uses MD5 checksums instead of MD4.
 
-    * 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).
+    - If a daemon module's "path" value is not an absolute pathname, the code
+      now makes it absolute internally (making it work properly).
 
-    * 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).
+    - Changed the --append option to not checksum the existing data in the
+      destination file, which speeds up file appending.
 
-    * 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 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.
 
-    * Fixed the "refuse options" setting in the rsyncd.conf file.
+    - 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 -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.
+    - 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 (*?[).
 
-    * 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).
+    - Improved the dashes and double-quotes in the nroff manpage output.
 
-    * Fixed compilation problem on Tru64 Unix (having to do with
-      sockaddr.sa_len and sockaddr.sin_len).
+    - We now support a lot more --no-OPTION override options.
 
   INTERNAL:
 
-    * Most of the I/O is now buffered, which results in a pretty
-      large speedup when running under MS Windows.  (Craig Barratt)
+    - 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.
 
-    * Optimizations to the name-handling/comparing code have made
-      some significant reductions in user-CPU time for large file
-      sets.
+    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
 
-    * Some variable-type cleanup that makes the code more consistent.
+    - Fixed a build problem with older (2.x) versions of gcc.
 
-    * Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - Added some isType() functions that make dealing with signed characters
+      easier without forcing variables via casts.
 
-    * Implemented a new algorithm for hard-link handling that speeds
-      up the code significantly.  (J.W. Schultz and Wayne Davison)
+    - Changed strcat/strcpy/sprintf function calls to use safer versions.
 
-    * 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.
+    - Upgraded the included popt version to 1.10.2 and improved its use of
+      string-handling functions.
 
-    * 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)
+    - Added missing prototypes for compatibility functions from the lib dir.
 
-    * More optimal data transmission for --hard-links (protocol 28).
+    - Configure determines if iconv() has a const arg, allowing us to avoid a
+      compiler warning.
 
-    * More optimal data transmission for --checksum (protocol 28).
+    - Made the sending of some numbers more efficient for protocol 30.
 
-    * Less memory is used when --checksum is specified.
+    - Make sure that a daemon process doesn't mind if the client was weird and
+      omitted the --server option.
 
-    * Less memory is used in the file list (a per-file savings).
+    - Improved the use of "const" on pointers.
 
-    * 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.
+    - Improved J.W.'s pool_alloc routines to add a way of freeing older
+      sections of a pool's memory.
 
-    * 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) 
+  DEVELOPER RELATED:
 
-    * 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).
+    - Rsync is now licensed under the GPLv3 or later.
 
-    * 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.
+    - 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,
+      and another file system does).
 
-    * Improved the internal uid/gid code to be more portable and
-      a little more optimized.
+    - 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 (since we'd quickly exceed the MAX_PROTOCOL_VERSION
+      if we incremented the main PROTOCOL_VERSION value for every minor
+      change during development).