Preparing for release of 2.6.5
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index c53bc56..6ac8cf1 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.1 (UNRELEASED)
-Protocol: 27 (unchanged)
-Changes since 2.6.0:
-
-  ENHANCEMENTS:
-
-    * Lower memory use and more optimal transfer of data over
-      the socket (see the INTERNAL section for details).
-
-    * The RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
+NEWS for rsync 2.6.5 (1 Jun 2005)
+Protocol: 29 (unchanged)
+Changes since 2.6.4:
+
+  OUTPUT CHANGES:
+
+    - Non-printable chars in filenames are now output using backslash-
+      escaped characters rather than '?'s.  Any non-printable character is
+      output using 3 digits of octal (e.g. "\n" -> "\012"), and a backslash
+      is now output as "\\".  Rsync also uses your locale setting, which
+      can make it treat fewer high-bit characters as non-printable.
+
+    - If rsync received an empty file-list when pulling files, it would
+      output a "nothing to do" message and exit with a 0 (success) exit
+      status, even if the remote rsync returned an error (it did not do
+      this under the same conditions when pushing files).  This was changed
+      to make the pulling behavior the same as the pushing behavior:  we
+      now do the normal end-of-run outputting (depending on options) and
+      exit with the appropriate exit status.
 
   BUG FIXES:
 
-    * The --link-dest code now works properly for a non-root user
-      when the UIDs of the source and destination differ and -u was
-      specified, and when the group of the source can't be used on
-      the destination and -g was specified.  (Wayne Davison)
+    - A crash bug was fixed when a daemon had its "path" set to "/", did
+      not have chroot enabled, and used some anchored excludes in the
+      rsyncd.conf file.
 
-    * 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).
-      (Wayne Davison)
-      
-    * Keep per-file track of the sending of literal data with
-      --partial so that an interrupted transfer doesn't keep a
-      shorter temp file when no new data has been transfered over
-      the wire.  (Wayne Davison)
+    - Fixed a bug in the transfer of a single file when -H is specified
+      (rsync would either infinite loop or perhaps crash).
 
-    * Fixed a byte-order problem in --batch-mode on big-endian
-      machines.  (Jay Fenlason)
+    - Fixed a case where the generator might try (and fail) to tweak the
+      write-permissions of a read-only directory in list-only mode (this
+      only caused an annoying warning message).
 
-    * Fixed configure bug when running "./configure --disable-ipv6".
-      (Wayne Davison)
+    - If --compare-dest or --link-dest uses a locally-copied file as the
+      basis for an updated version, log this better when --verbose or -i
+      is in effect.
 
-    * Fixed "make test" bug when build dir is not the source dir.
+    - Fixed the accidental disabling of --backup during the --delete-after
+      processing.
 
-  INTERNAL:
+    - Restored the ability to use the --address option in client mode (in
+      addition to its use in daemon mode).
 
-    * Most of the I/O is now buffered, which results in a pretty
-      large speedup when running under MS Windows.  (Craig Barratt)
+    - Make sure that some temporary progress information from the delete
+      processing does not get left on the screen when it is followed by a
+      newline.
 
-    * Optimizations to the name-handling/comparing code have made
-      some significant reductions in user-CPU time for large file
-      sets.  (Wayne Davison)
+    - When --existing skips a directory with extra verbosity, refer to it
+      as a "directory", not a "file".
 
-    * Some variable-type cleanup that makes the code more consistent.
-      (Wayne Davison)
+    - When transferring a single file to a different-named file, any
+      generator messages that are source-file related no longer refer to
+      the file by the destination filename.
 
-    * Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - Fixed a bug where hard-linking a group of files might fail if the
+      generator hasn't created a needed destination directory yet.
 
-    * Implemented a new algorithm for hard-link handling that speeds
-      up the code significantly.  (J.W. Schultz and Wayne Davison)
+    - Fixed a bug where a hard-linked group of files that is newly-linked
+      to a file in a --link-dest dir doesn't link the files from the rest
+      of the cluster.
 
-    * Got rid of support for protocol versions 17 and 18 (which are
-      both over 6 years old).  (Wayne Davison)
+    - When deleting files with the --one-file-system (-x) option set, rsync
+      no longer tries to remove files from inside a mount-point on the
+      receiving side.  Also, we don't complain about being unable to remove
+      the mount-point dir.
 
-    * More optimal data transmission for --hard-links (protocol 28).
+    - Fixed a compatibility problem when using --cvs-ignore (-C) and
+      sending files to an older rsync without using --delete.
 
-    * More optimal data transmission for --checksum (protocol 28).
+    - Make sure that a "- !" or "+ !" include/exclude pattern does not
+      trigger the list-clearing action that is reserved for "!".
 
-    * Less memory used for holding --checksum data.
+    - Avoid a timeout in the generator when the sender/receiver aren't
+      handling the generator's checksum output quickly enough.
 
-    * Less memory used per-file in the file list.
+    - Fixed the omission of some directories in the delete processing when
+      --relative (-R) was combined with a source path that had a trailing
+      slash.
 
-    * 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 to through generator over
-      to the sender.  (Wayne Davison)
+    - Fixed a case where rsync would erroneously delete some files and then
+      re-transfer them when the options --relative (-R) and --recursive
+      (-r) were both enabled (along with --delete) and a source path had a
+      trailing slash.
 
-\f
-NEWS for rsync 2.6.0 (1 Jan 2004)
-Protocol: 27 (changed)
-Changes since 2.5.7:
+    - Make sure that --max-size doesn't affect a device or a symlink.
 
-  ENHANCEMENTS:
+    - Make sure that a system with a really small MAXPATHLEN does not cause
+      the buffers in readfd_unbuffered() to be too small to receive normal
+      messages.  (This mainly affected Cygwin.)
 
-    * "ssh" is now the default remote shell for rsync.  If you want to
-      change this, configure like this:  "./configure --with-rsh=rsh".
+    - If a source pathname ends with a filename of "..", treat it as if
+      "../" had been specified (so that we don't copy files to the parent
+      dir of the destination).
 
-    * Added --files-from, --no-relative, --no-implied-dirs, and --from0.
-      Note that --from0 affects the line-ending character for all the
-      files read by the --*-from options. (Wayne Davison)
+    - If --delete is combined with a file-listing rsync command (i.e. no
+      transfer is happening), avoid outputting a warning that we couldn't
+      delete anything.
 
-    * Length of csum2 is now per-file starting with protocol version
-      27. (J.W. Schultz)
+    - If --stats is specified with --delete-after, ensure that all the
+      "deleting" messages are output before the statistics.
 
-    * Per-file dynamic block size is now sqrt(file length).  The
-      per-file checksum size is determined according to an algorithm
-      provided by Donovan Baarda which reduces the probability of rsync
-      algorithm corrupting data and falling back using the whole md4
-      checksums. (J.W. Schultz, Donovan Baarda)
-
-    * The --stats option no longer includes the (debug) malloc summary
-      unless the verbose option was specified at least twice.
-
-    * Added a new error/warning code for when files vanish from the
-      sending side.  Made vanished source files not interfere with the
-      file-deletion pass when --delete-after was specified.
-
-    * Various trailing-info sections are now preceded by a newline.
-
-  BUG FIXES:
+    - Improved one "if" in the deletion code that was only checking errno
+      for ENOTEMPTY when it should have also been checking for EEXIST (for
+      compatibility with OS variations).
 
-    * Fixed several exclude/include matching bugs when using wild-cards.
-      This has a several user-visible effects, all of which make the
-      matching more consistent and intuitive.  This should hopefully not
-      cause anyone problems since it makes the matching work more like
-      what people are expecting. (Wayne Davison)
-
-      - A pattern with a "**" no longer causes a "*" to match slashes.
-        For example, with "/*/foo/**", "foo" must be 2 levels deep.
-       [If your string has BOTH "*" and "**" wildcards, changing the
-       "*" wildcards to "**" will provide the old behavior in all
-       versions.]
-
-      - "**/foo" now matches at the base of the transfer (like /foo
-        does).  [Use "/**/foo" to get the old behavior in all versions.]
-
-      - A non-anchored wildcard term floats to match beyond the base of
-        the transfer.  E.g. "CVS/R*" matches at the end of the path,
-        just like the non-wildcard term "CVS/Root" does. [Use "/CVS/R*"
-        to get the old behavior in all versions.]
-
-      - Including a "**" in the match term causes it to be matched
-        against the entire path, not just the name portion, even if
-        there aren't any interior slashes in the term.  E.g. "foo**bar"
-        would exclude "/path/foo-bar" (just like before) as well as
-        "/foo-path/baz-bar" (unlike before).  [Use "foo*bar" to get the
-        old behavior in all versions.]
-
-    * The exclude list specified in the daemon's config file is now
-      properly applied to the pulled items no matter how deep the
-      user's file-args are in the source tree.  (Wayne Davison)
-
-    * For protocol version >= 27, mdfour_tail() is called when the
-      block size (including checksum_seed) is a multiple of 64.
-      Previously it was not called, giving the wrong MD4 checksum.
-      (Craig Barratt)
-
-    * For protocol version >= 27, a 64 bit bit counter is used in
-      mdfour.c as required by the RFC.  Previously only a 32 bit bit
-      counter was used, causing incorrect MD4 file checksums for
-      file sizes >= 512MB - 4.  (Craig Barratt)
+  ENHANCEMENTS:
 
-    * Fixed a crash bug when interacting with older rsync versions and
-      multiple files of the same name are destined for the same dir.
-      (Wayne Davison)
+    - Added the --only-write-batch=FILE option that may be used (instead
+      of --write-batch=FILE) to create a batch file without doing any
+      actual updating of the destination.  This allows you to divert all
+      the file-updating data away from a slow data link (as long as you
+      are pushing the data to the remote server when creating the batch).
 
-    * Keep tmp names from overflowing MAXPATHLEN.
+    - When the generator is taking a long time to fill up its output buffer
+      (e.g. if the transferred files are few, small, or missing), it now
+      periodically flushes the output buffer so that the sender/receiver
+      can get started on the files sooner rather than later.
 
-    * Make --link-dest honor the absence of -p, -o, and -g.
+    - Improved the keep-alive code to handle a long silence between the
+      sender and the receiver that can occur when the sender is receiving
+      the checksum data for a large file.
 
-    * Made rsync treat a trailing slash in the destination in a more
-      consistent manner.
+    - Improved the auth-errors that are logged by the daemon to include
+      some information on why the authorization failed:  wrong user,
+      password mismatch, etc.  (The client-visible message is unchanged!)
 
-    * Fixed file I/O error detection.  (John Van Essen)
+    - Improved the client's handling of an "@ERROR" from a daemon so that
+      it does not complain about an unexpectedly closed socket (since we
+      really did expect the socket to close).
 
-    * Fixed bogus "malformed address {hostname}" message in rsyncd log
-      when checking IP address against hostnames from "hosts allow"
-      and "hosts deny" parameters in config file.
+    - If the daemon can't open the log-file specified in rsyncd.conf, fall
+      back to using syslog and log an appropriate warning.  This is better
+      than what was typically a totally silent (and fatal) failure (since a
+      daemon is not usually run with the --no-detach option that was
+      necessary to see the error on stderr).
 
-    * Print heap statistics when verbose >= 2 instead of when >= 1.
+    - The man pages now consistently refer to an rsync daemon as a "daemon"
+      instead of a "server" (to distinguish it from the server process in a
+      non-daemon transfer).
 
-    * Fixed a compression (-z) bug when syncing a mostly-matching file
-      that contains already-compressed data.  (Yasuoka Masahiko and
-      Wayne Davison)
+    - Made a small change to the rrsync script (restricted rsync -- in the
+      support dir) to make a read-only server reject all --remove-* options
+      when sending files (to future-proof it against the possibility of
+      other similar options being added at some point).
 
-    * Fixed a bug in the --backup code that could cause deleted files
-      to not get backed up.
+  INTERNAL:
 
-    * When the backup code makes new directories, create them with mode
-      0700 instead of 0755 (since the directory permissions in the
-      backup tree are not yet copied from the main tree).
+    - Rsync now calls setlocale(LC_CTYPE, "").  This enables isprint() to
+      better discern which filename characters need to be escaped in
+      messages (which should result in fewer escaped characters in some
+      locales).
 
-    * Call setgroups() in a more portable manner.
+    - Improved the naming of the log-file open/reopen/close functions.
 
-    * Improved file-related error messages to better indicate exactly
-      what pathname failed. (Wayne Davison)
+    - Removed some protocol-compatibility code that was only needed to help
+      someone running a pre-release of 2.6.4.
 
-    * Fixed some bugs in the handling of --delete and --exclude when
-      using the --relative (-R) option. (Wayne Davison)
+  BUILD CHANGES:
 
-    * Fixed bug that prevented regular files from replacing
-      special files and caused a directory in --link-dest or
-      --compare-dest to block the creation of a file with the
-      same path.  A directory still cannot be replaced by a
-      regular file unless --delete specified.  (J.W. Schultz)
+    - Added configure option "--disable-locale" to disable any use of
+      setlocale() in the binary.
 
-    * Detect and report when open or opendir succeed but read and
-      readdir fail caused by network filesystem issues and truncated
-      files.  (David Norwood, Michael Brown, J.W. Schultz)
+    - Fixed a bug in the SUPPORT{,_HARD}_LINKS #defines which prevented
+      rsync from being built without symlink or hard-link support.
 
-    * Added a fix that should give ssh time to restore the tty settings
-      if the user presses Ctrl-C at an ssh password prompt.
+    - Only #define HAVE_REMSH if it is going to be set to 1.
 
-  INTERNAL:
+    - Configure now disables the use of mkstemp() under HP-UX (since they
+      refuse to fix its broken handling of large files).
 
-    * Eliminated vestigial support for old versions that we stopped
-      supporting. (J.W. Schultz)
+    - Configure now explicitly checks for the lseek64() function so that
+      the code can use HAVE_LSEEK64 instead of inferring lseek64()'s
+      presence based on the presence of the off64_t type.
 
-    * Simplified some of the option-parsing code. (Wayne Davison)
+    - Configure no longer mentions the change in the default remote-shell
+      (from rsh to ssh) that occurred for the 2.6.0 release.
 
-    * Some cleanup made to the exclude code, as well as some new
-      defines added to enhance readability. (Wayne Davison)
+    - Some minor enhancements to the test scripts.
 
-    * Changed the protocol-version code so that it can interact at a
-      lower protocol level than the maximum supported by both sides.
-      Added an undocumented option, --protocol=N, to force the value
-      we advertise to the other side (primarily for testing purposes).
-      (Wayne Davison)
+    - Added a few new *.diff files to the patches dir, including a patch
+      that enables the optional copying of extended attributes.