Mention the output change for a mount-dir when -x is used.
[rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index c231981b28e3e6a21e17f016f9856ac1164a833e..21b2783a35fa77dc1a1e034bebbfc89f9273e857 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.4 (UNRELEASED)
-Protocol: 29 (changed)
-Changes since 2.6.3:
+NEWS for rsync 2.6.5 (UNRELEASED)
+Protocol: 29 (unchanged)
+Changes since 2.6.4:
 
   OUTPUT CHANGES:
 
-    - When rsync deletes a directory and outputs a verbose message about
-      it, it now appends a trailing slash to the name instead of (only
-      sometimes) outputting a preceding "directory " string.
+    - 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.
 
-    - The --stats output will contain file-list time-statistics if both
-      sides are 2.6.4, or if the local side is 2.6.4 and the files are
-      being pushed (since the stats come from the sending side).
-      (Requires protocol 29 for a pull.)
+    - 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.
 
-    - The "%o" (operation) value now has a third value besides "send" and
-      "recv": "del." (with trailing dot to make it 4 chars).  This changes
-      the way deletions are logged in the daemon's log file.
-  
   BUG FIXES:
 
-    - Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
-      was only treating it as a special token in an rsync include/exclude
-      file).
+    - 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.
 
-    - The combination of --verbose and --dry-run now mentions the full list
-      of changes that would be output without --dry-run.
+    - Fixed a bug in the transfer of a single file when -H is specified
+      that might have caused an infinite loop or perhaps a crash.
 
-    - Avoid a mkdir warning when removing a directory in the destination
-      that already exists in the --backup-dir.
+    - Fixed a case where the generator might try to tweak the write
+      permissions of a read-only directory in list-only mode.
 
-    - An OS that has a binary mode for its files (such as cygwin0 needed
-      setmode(fd, O_BINARY) called on the temp-file we opened with
-      mkstemp().  (Fix derived from the Cygwin's 2.6.3 rsync package.)
+    - 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 a potential hang when verbosity is high, the client side is
-      the sender, and the file-list is large.
+    - Fixed the accidental disabling of --backup during the --delete-after
+      processing.
 
-    - We now check if the OS doesn't support using mknod() for creating
-      FIFOs and sockets, and compile-in using mkfifo() and socket() when
-      necessary.
+    - Restored the ability to use the --address option in client mode (in
+      addition to its use in daemon mode).
 
-    - Fixed an off-by-one error in the handling of --max-delete=N.
+    - 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.
 
-    - One place in the code wasn't checking if fork() failed.
+    - When --existing skips a directory with extra verbosity, refer to it
+      as a "directory", not a "file".
 
-    - The "ignore nonreadable" daemon parameter used to erroneously affect
-      symlinks that pointed to a non-existent file.  This has been fixed.
+    - 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.
 
-    - If the OS does not have lchown() and its chown() tries to set the
-      referent of a symlink (as it should), we no longer try to set the
-      user and group of a symlink.
+    - Fixed a bug where hard-linking a group of files might fail if the
+      generator hasn't created a needed destination directory yet.
 
-    - The generator now properly runs the hard-link loop and the dir-time
-      rewriting loop after we're sure that the redo phase is complete.
+    - 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.
 
-    - When --backup was specified with --partial-dir=DIR (where DIR is a
-      relative path), the backup code was erroneously trying to backup a
-      file that was put into the partial-dir.
+    - 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.
 
-    - One call to flush_write_file() was not being checked for an error.
+    - Fixed a compatibility problem when using --cvs-ignore (-C) and
+      sending files to an older rsync without using --delete.
 
-    - The --no-relative option was not being sent from the client to a
-      server sender.
+    - Make sure that a "- !" or "+ !" include/exclude pattern does not
+      trigger the list-clearing action that is reserved for "!".
 
-    - If an rsync daemon specified "dont compress = ..." for a file and the
-      client tried to specify --compress, the libz code was not handling a
-      compression level of 0 properly.  This could cause a transfer failure
-      if the block-size for a file was large enough (i.e. rsync might have
-      exited with an error for large files).
+    - Avoid a timeout in the generator when the sender/receiver aren't
+      handling the generator's checksum output quickly enough.
 
-    - If a daemon can't open the specified log file (i.e. syslog is not
-      being used), die without crashing.  We also output an error about
-      the failure on stderr (which will only be seen if --no-detach was
-      specified).
+    - Fixed the ommission of some directories in the delete processing when
+      --relative (-R) was combined with a source path that had a trailing
+      slash.
 
-    - A local transfer no longer duplicates all its include/exclude options
-      (since the forked process already has a copy of the exclude list,
-      there's no need to send them a set of duplicates).
+    - Make sure that --max-size doesn't affect a device or a symlink.
 
-  ENHANCEMENTS:
-
-    - Rsync now supports popt's option aliases, which means that you can
-      use /etc/popt and/or ~/.popt to create your own option aliases.
-
-    - Added the --delete-during (--del) option which will delete files
-      from on the receiving side incrementally as each directory in the
-      transfer is being processed.  This makes it more efficient than the
-      default, before-the-transfer behavior, which is now available as
-      --delete-before (this is the default --delete-WHEN option that will
-      be chosen if --delete or --delete-excluded is specified without a
-      --delete-WHEN choice).  All the --del* options infer --delete, so an
-      rsync daemon that refuses "delete" will still refuse to allow any
-      file-deleting options.
-
-    - All the --delete-WHEN options are now more memory efficient:
-      Previously an entire duplicate set of file-list objects was created
-      on the receiving side for the entire destination hierarchy.  The new
-      algorithm only creates one directory of objects at a time.
-
-    - Added the --copy-dest option, which works like --link-dest except
-      that it includes copies of identical files.
-
-    - Added support for specifying multiple --compare-dest, --copy-dest, or
-      --link-dest options, but only of a single type. (Promoted from the
-      patches dir and enhanced.)
-
-    - Added the --max-size option. (Promoted from the patches dir.)
-
-    - The daemon-mode options were separated from the normal rsync options
-      so that they can't be mixed together.  This makes it impossible to
-      start a daemon that had improper default option values that could
-      cause problems (e.g. a hang or an abort) when a client connects.
-
-    - The --bwlimit option may now be used in combination with --daemon
-      to specify both a default value for the daemon side and a value
-      that cannot be exceeded by a user-specified --bwlimit option.
-
-    - Added the "port" parameter to the rsyncd.conf file. (Promoted from
-      the patches dir.)  Also added "address".  A command-line option
-      will take precedence over a config-file option, as expected.
-
-    - In _exit_cleanup(): when we are exiting with a partially-received
-      file, we now flush any data in the write-cache before closing the
-      partial file.
-
-    - The --inplace support was enhanced to work with --compare-dest,
-      --link-dest, and (the new) --copy-dest options. (Requires protocol
-      29.)
-
-    - Added the --dirs (-d) option for an easier way to copy directories
-      without recursion.
-
-    - Added the --list-only option which is mainly a way for the client to
-      put the server into listing mode without needing to resort to any
-      internal option kluges (e.g. the age-old use of "-r --exclude="/*/*"
-      for a non-recursive listing).  This option is used automatically
-      (behind the scenes) when a modern rsync speaks to a modern daemon,
-      but may also be specified manually if you want to force the use of
-      the --list-only option over a remote-shell connection.
-
-    - Added the --omit-dir-times (-O) option which will avoid updating the
-      modified time for directories when --times was specified.  This
-      option will avoid an extra pass through the file-list at the end of
-      the transfer (to tweak all the directory times), which can result in
-      an appreciable speedup for a really large transfer. (Promoted from
-      the patches dir.)
-
-    - Added the --filter (-f) option and its helper option, -F.  Filter
-      rules are an extension to the existing include/exclude handling
-      that also supports nested filter files as well as per-directory
-      filter files (like .cvsignore, but with full filter-rule parsing).
-      This new option was chosen in order to ensure that all existing
-      include/exclude processing remained 100% compatible with older
-      versions.  Protocol 29 is needed for full filter-rule support, but
-      backward-compatible rules work with earlier protocol versions.
-      (Promoted from the patches dir and enhanced.)
-
-    - Added the --delay-updates option that puts all updated files into
-      a temporary directory (by default ".~tmp~", but settable via the
-      --partial-dir=DIR option) until the end of the transfer.  This
-      makes the updates a little more atomic for a large transfer.
-
-    - If rsync is put into the background, any output from --progress is
-      reduced.
-
-    - Documented the "max verbosity" setting for rsyncd.conf.  (This
-      setting was added a couple releases ago, but left undocumented.)
-
-    - The sender and the generator now double-check the file-list index
-      they are given, and refuse to try to do a file transfer on a
-      non-file index (since that would indicate that something had gone
-      very wrong).
-
-    - Added the --itemize-changes (-i) option, which is a way to output a
-      more detailed list of what files changed in any way and how they
-      changed.  The effect is the same as specifying a --log-format of
-      "%i %n%L" (see the rsyncd.conf manpage).  Works with --dry-run too.
-
-    - Added the --fuzzy option, which attempts to find a basis file for a
-      file that is being created from scratch.  The current algorithm
-      only looks in the destination directory for the created file, but
-      it does attempt to find a match based on size/mod-time (in case the
-      file was renamed with no other changes) as well as based on a fuzzy
-      name-matching algorithm.  This option requires protocol 29 because
-      it needs the new file-sorting order.  (Promoted from patches dir
-      and enhanced.)
-
-    - Added the --remove-sent-files option, which lets you move files
-      between systems.
-
-    - Improved the option descriptions in the --help text.
-
-  SUPPORT FILES:
-
-    - Added atomic-rsync to the support dir: a perl script that will
-      transfer some files using rsync, and then move the updated files into
-      place all at once at the end of the transfer.  Only works when
-      pulling, and uses --link-dest and a parallel hierarchy of files to
-      effect its update.
-
-    - Added mnt-excl to the support dir: a perl script that takes the
-      /proc/mounts file and translates it into a set of excludes that will
-      exclude all mount points (even mapped mounts to the same disk).  The
-      excludes are made relative to the specified source dir and properly
-      anchored.
-
-    - Added savetransfer.c to the support dir: a C program that can make
-      a copy of all the data that flows over the wire.  This lets you test
-      for data corruption (by saving the data on both the sending side and
-      the receiving side) or provides a way to help debug a protocol error.
-
-    - Added rrsync to the support dir: this is my version of Joe Smith's
-      restricted rsync perl script.  This helps to ensure that only certain
-      rsync commands can be run by an ssh invocation.
+    - 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.)
 
-  INTERNAL:
+    - If a source filename ends with "..", treat it as if "../" had been
+      specified (so that we don't copy files to the parent dir of the
+      destination).
 
-    - Added better checking of the checksum-header values that come over
-      the socket.
+    - 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.
 
-    - Merged a variety of file-deleting functions into a single function so
-      that it is easier to maintain.
+    - If --stats is specified with --delete-after, ensure that all the
+      "deleting" messages are output before the statistics.
 
-    - Improved the type of some variables (particularly blocksize vars) for
-      consistency and proper size.
+    - Improved one "if" in the deletion code that was only checking errno
+      for ENOTEMPTY when it should have also been checking for EEXIST.
 
-    - Got rid of the uint64 type (which we didn't need).
+  ENHANCEMENTS:
 
-    - Use a slightly more compatible set of core #include directives.
+    - 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).
 
-    - Defined int32 in a way that ensures that the build dies if we can't
-      find a variable with at least 32 bits.
+    - 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.
 
-    - The daemon's "read only" config item now sets an internal read_only
-      variable that makes extra sure that no write/delete calls on the
-      read-only side can succeed.
+    - 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.
 
-  PROTOCOL DIFFERENCES FOR VERSION 29:
+    - 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.)
 
-    - A 16-bit flag-word is transmitted after every file-list index.  This
-      indicates what is changing between the sender and the receiver.  The
-      generator now transmits an index and a flag-word to indicate when
-      dirs and symlinks have changed (resorting to the old-style outputting
-      of local change-messages for older protocols).
+    - 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).
 
-    - If --inplace is specified, the generator sends an extra byte after
-      the flag-word indicating what kind of basis file is being used for
-      the transfer (see the FNAMECMP_* defines).  This information is used
-      to optimize the transfer when the basis file is not the destination.
+    - 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 failure (since a
+      daemon is not usually run with the --no-detach option that was
+      necessary to see the error on stderr).
 
-    - The sending of exclude names is done using filter-rule syntax.  This
-      means that all names have a prefixed rule indicator, even excludes
-      (which used to be sent as a bare pattern, when possible).  The -C
-      option will include the per-dir .cvsignore merge file in the list of
-      filter rules so it is positioned correctly (unlike in some older
-      transfer scenarios).
+    - The man pages now consistently refer to an rsync daemon as a "daemon"
+      to distinguish it from a server in a non-daemon transfer.
 
-    - Rsync sorts the filename list in a different way: it sorts the subdir
-      names after the non-subdir names for each dir's contents, and it
-      always puts a dir's contents immediately after the dir's name in the
-      list.  (Previously an item named "foo.txt" would sort in between
-      directory "foo/" and "foo/bar".)
+    - 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).
 
-    - When talking to a protocol 29 rsync daemon, a list-only request
-      is able to note this before the options are sent over the wire, and
-      the new --list-only option is encluded in the options sent over the
-      socket.
+  INTERNAL:
 
-    - When the --stats bytes are sent over the wire (or stored in a batch),
-      they now include two elapsed-time values: one for how long it took to
-      build the file-list, and one for how long it took to send it over the
-      wire (each expressed in thousandths of a second).
+    - Rsync now calls setlocale(LC_CTYPE, "") to enable isprint() to better
+      discern which filename characters need to be escaped in messages.
 
-    - When --delete-excluded is specified with some filter rules (AKA
-      excludes), a client sender will now initiate a send of the filter
-      rules to the receiver (older protocols used to omit the sending of
-      excludes in this situation since there were no receiver-specific
-      rules that survived --delete-excluded back then).  Note that, as with
-      all the filter-list sending, only items that are significant to the
-      other side will actually be sent over the wire, so the filter-rule
-      list is often empty in this scenario.
+    - Improved the naming of the log-file open/reopen/close functions.
 
-    - A protocol-29 batch file includes a bit for the setting of the --dirs
-      option.  Also, the shell script created by --write-batch will use the
-      --filter option instead of --exclude-from to capture any filter rules.
+    - Removed some protocol compatibility code that was only needed to help
+      someone running a pre-release of 2.6.4.
 
   BUILD CHANGES:
 
-    - Handle an operating system that use mkdev() in place of makedev().
+    - Fixed a bug in the SUPPORT{,_HARD}_LINKS defines which prevented
+      rsync from being built without symlink or hard-link support.
+
+    - You can use --disable-locale to turn off any use of setlocale().
+
+    - Configure now disables the use of mkstemp() under HP-UX (since they
+      refuse to fix its broken handling of large files).
+
+    - 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.
+
+    - Some minor enhancements to the test scripts.
 
-    - Improved configure to better handle cross-compiling.
+    - Added a few new diffs to the patches dir, including a patch that
+      enables the optional copying of extended attributes.