Preparing for release of 3.0.0pre1
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index d5faa96..f45d762 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.3 (UNRELEASED)
-Protocol: 28 (unchanged)
-Changes since 2.6.2:
+NEWS for rsync 3.0.0 (UNRELEASED)
+Protocol: 30 (changed)
+Changes since 2.6.9:
 
-  BUG FIXES:
-
-    - Fixed a crash bug that might appear when --delete was used and
-      multiple source directories were specified.
-
-    - The --backup code no longer attempts to create some directories
-      over and over again (generating warnings along the way).
-
-    - Fixed a bug in the reading of the secrets file (by the daemon) and
-      the password file (by the client):  the files no longer need to be
-      terminated by a newline for their content to be read in.
-
-    - If a file has a read error on the sending side, the receiver will
-      no longer keep the resulting file unless the --partial option was
-      specified.  (Note:  both sides must be running 2.6.3 for this to
-      work -- older receivers always keep the file, and older senders
-      don't tell the receiver that the file was not read correctly.)
-
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
-
-    - Files specified in the daemon's "exclude" or "exclude from" config
-      items are now excluded from being uploaded (if the module is not
-      read-only) in addition to the old download exclusion.
-
-    - When using --backup without a --backup-dir, rsync no longer preserves
-      the modify time on directories.  This avoids confusing NFS.
-
-    - Fixed a bug in the daemon authentication code when using one of the
-      batch-processing options.
-
-  ENHANCEMENTS:
-
-    - Added the "write only" option to the daemon's config file.
-
-    - Added the --checksum-seed=N option for advanced users.
-
-    - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
-      and documented all these options in the man page.
-
-  INTERNAL:
-
-    - Some cleanup in the exclude code has saved some per-exclude memory
-      and made the code easier to maintain.
-
-    - Use rsyserr() in the various places that were still calling
-      rprintf() with strerror() as an arg.
+  NOTABLE CHANGE IN BEHAVIOR:
 
-  BUILD CHANGES:
-
-    - Added a "gen" target to rebuild most of the various generated
-      files, including configure, config.h.in, the man pages, and
-      proto.h.
-
-    - The timestamp of the proto.h file is unaltered by "make proto"
-      if the contents don't change.
-
-  DEVELOPER RELATED:
-
-    - The scripts in the testsuite dir were cleaned up a bit.
-
-\f
-NEWS for rsync 2.6.2 (30 Apr 2004)
-Protocol: 28 (unchanged)
-Changes since 2.6.1:
+   - 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.
 
   BUG FIXES:
 
-    - Fixed a major bug in the sorting of the filenames when --relative
-      is used for some sources (just sources such as "/" and "/*" were
-      affected).  This fix ensures that we ask for the right file-list
-      item when requesting changes from the sender.
-
-    - Rsync now checks the return value of the close() function to
-      better report disk-full problems on an NFS file system.
+    - Fixed the output of -ii when combined with one of the --*-dest options:
+      it now itemizes all the items, not just the changed ones.
 
-    - Restored the old daemon-server behavior of logging error messages
-      rather than returning them to the user.  (A better long-term fix
-      will be sought in the future.)
+    - 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.
 
-    - An obscure uninitialized-variable bug was fixed in the uid/gid
-      code.  (This bug probably had no ill effects.)
+    - 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.
 
-  BUILD CHANGES:
+    - A negated filter rule (with a '!' modifier) no longer loses the negation
+      when sending the filter rules to the remote rsync.
 
-    - Got rid of the configure check for sys/sysctl.h (it wasn't used
-      and was causing a problem on some systems).  Also improved the
-      broken-largefile-locking test to try to avoid failure due to an
-      NFS build-dir.
+    - 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 compile problem on systems that don't define
-      AI_NUMERICHOST.
+    - 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.
 
-    - Fixed a compile problem in the popt source for compilers that
-      don't support __attribute__.
+    - 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.
 
-  DEVELOPER RELATED:
+    - Make sure that directory permissions of a newly-created destination
+      directory are handled right when --perms is left off.
 
-    - Improved the testsuite's "merge" test to work on OSF1.
+    - The itemized output of a newly-created destination directory is now
+      output as a creation event, not a change event.
 
-    - Two new diffs were added to the patches dir.
+    - Improved --hard-link so that more corner cases are handled correctly
+      when combined with options such as --link-dest and/or --ignore-existing.
 
-\f
-NEWS for rsync 2.6.1 (26 Apr 2004)
-Protocol: 28 (changed)
-Changes since 2.6.0:
+    - The --append option no longer updates a file that has the same size.
 
-  SECURITY FIXES:
+    - Fixed a bug when combining --backup and --backup-dir with --inplace:
+      any missing backup directories are now created.
 
-    - Paths sent to an rsync daemon are more thoroughly sanitized when
-      chroot is not used.  If you're running a non-read-only rsync
-      daemon with chroot disabled, *please upgrade*, ESPECIALLY if the
-      user privs you run rsync under is anything above "nobody".
+    - Fixed a bug when using --backup and --inplace with --whole-file or
+      --read-batch: backup files are actually created now.
 
-  ENHANCEMENTS:
+    - 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.
 
-    - Lower memory use, more optimal transfer of data over the socket,
-      and lower CPU usage (see the INTERNAL section for details).
+    - The daemon pidfile is checked and created sooner in the startup sequence.
 
-    - The RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
-
-    - 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.
-
-    - Documentation changes now attempt to describe some often mis-
-      understood features more clearly.
+  ENHANCEMENTS:
 
-  BUG FIXES:
+    - 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.
+      
+    - 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.
 
-    - When -x (--one-file-system) is combined with -L (--copy-links) or
-      --copy-unsafe-links, no symlinked files are skipped, even if the
-      referent file is on a different filesystem.
+    - 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.)
 
-    - 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.
+    - 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).
 
-    - 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.
-
-    - Fixed a byte-order problem in --batch-mode on big-endian machines.
-      (Jay Fenlason)
-
-    - When using --cvs-exclude, the exclude items we get from a
-      per-directory's .cvsignore file once again only affect that one
-      directory (not all following directories too).  The items are also
-      now properly word-split and parsed without any +/- prefix parsing.
-
-    - 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).
-
-    - 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.
-
-    - Fixed the "refuse options" setting in the rsyncd.conf file.
-
-    - 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 remapped mount of the
-      original filesystem could get discovered in a subdir we should be
-      ignoring.
-
-    - 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).
-
-    - Path-specifying options to a daemon should now work the same with
-      or without chroot turned on.  Previously, such a option (such as
-      --link-dest) would get its absolute path munged into a relative
-      one if chroot was not on, making that setting fairly useless.
-      Rsync now transforms the path into one that is based on the
-      module's base dir when chroot is not enabled.
-
-    - Fixed a compatibility problem interacting with older rsync
-      versions that might send us an empty --suffix value without
-      telling us that --backup-dir was specified.
-
-    - 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.
-
-    - Fixed the ability to request an empty backup --suffix when sending
-      files to an rsync daemon.
+    - 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).
 
-  INTERNAL:
+    - 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.
 
-    - Most of the I/O is now buffered, which results in a pretty large
-      speedup when running under MS Windows.  (Craig Barratt)
+    - 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).
 
-    - Optimizations to the name-handling/comparing code have made some
-      significant reductions in user-CPU time for large file sets.
+    - Protocol 30 now uses MD5 checksums instead of MD4.
 
-    - Some cleanup of the variable types make the code more consistent.
+    - If a daemon module's "path" value is not an absolute pathname, the code
+      now makes it absolute internally (making it work properly).
 
-    - Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - Changed the --append option to not checksum the existing data in the
+      destination file, which speeds up file appending.
 
-    - Implemented a new algorithm for hard-link handling that speeds up
-      the code significantly.  (J.W. Schultz and Wayne Davison)
+    - 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.
 
-    - 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.
+    - Documented and extended the support for the RSYNC_CONNECT_PROG variable
+      that can be used to enhance the client side of a daemon connection.
 
-    - 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 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 (*?[).
 
-    - More optimal data transmission for --hard-links (protocol 28).
+    - Improved the dashes and double-quotes in the nroff manpage output.
 
-    - More optimal data transmission for --checksum (protocol 28).
+    - We now support a lot more --no-OPTION override options.
 
-    - Less memory is used when --checksum is specified.
+  INTERNAL:
 
-    - Less memory is used in the file list (a per-file savings).
+    - 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.
 
-    - 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.
+    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
 
-    - Changed hardlink info and file_struct + strings to use allocation
-      pools.  This reduces memory use for large file-sets and permits
-      freeing memory to the OS.  (J.W. Schultz) 
+    - Fixed a build problem with older (2.x) versions of gcc.
 
-    - 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 (which mainly affected hard-link messages and
-      verbose --stats output).
+    - Added some isType() functions that make dealing with signed characters
+      easier without forcing variables via casts.
 
-    - Improved the internal uid/gid code to be more portable and a
-      little more optimized.
+    - Changed strcat/strcpy/sprintf function calls to use safer versions.
 
-    - The device numbers sent when using --devices are now sent as
-      separate major/minor values with 32-bit accuracy (protocol 28).
-      Previously, the copied devices were sent as a single 32-bit
-      number.  This will make inter-operation of 64-bit binaries more
-      compatible with their 32-bit brethren (with both ends of the
-      connection are using protocol 28).  Note that optimizations in the
-      binary protocol for sending the device numbers often results in
-      fewer bytes being used than before, even though more precision is
-      now available.
+    - Upgraded the included popt version to 1.10.2 and improved its use of
+      string-handling functions.
 
-    - Some cleanup of the exclude/include structures and its code made
-      things clearer (internally), simpler, and more efficient.
+    - Added missing prototypes for compatibility functions from the lib dir.
 
-    - 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.  (Note that the
-      batch code is still considered to be experimental.)
+    - Configure determines if iconv() has a const arg, allowing us to avoid a
+      compiler warning.
 
-  BUILD CHANGES:
+    - Made the sending of some numbers more efficient for protocol 30.
 
-    - The configure script now accepts --with-rsyncd-conf=PATH to
-      override the default value of the /etc/rsyncd.conf file.
+    - Make sure that a daemon process doesn't mind if the client was weird and
+      omitted the --server option.
 
-    - Fixed configure bug when running "./configure --disable-ipv6".
+    - Improved the use of "const" on pointers.
 
-    - Fixed compilation problem on Tru64 Unix (having to do with
-      sockaddr.sa_len and sockaddr.sin_len).
+    - Improved J.W.'s pool_alloc routines to add a way of freeing older
+      sections of a pool's memory.
 
   DEVELOPER RELATED:
 
-    - Fixed "make test" bug when build dir is not the source dir.
+    - Rsync is now licensed under the GPLv3 or later.
 
-    - Added a couple extra diffs in the "patches" dir, removed the ones
-      that got applied, and rebuilt the rest.
+    - 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).
 
+    - 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).