Mention the output change for a mount-dir when -x is used.
[rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 900eb781ef2e0103f9d3e3a38983d22fd06d7532..21b2783a35fa77dc1a1e034bebbfc89f9273e857 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.4 (UNRELEASED)
-Protocol: 28 (unchanged)
-Changes since 2.6.3:
+NEWS for rsync 2.6.5 (UNRELEASED)
+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:
 
-    - 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.
 
-    - Avoid a mkdir warning when removing a directory in the destination
-      that already exists in the --backup-dir.
+    - 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.
 
-    - 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().
+    - Fixed a case where the generator might try to tweak the write
+      permissions of a read-only directory in list-only mode.
 
-    - 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.
+    - 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 an off-by-one error in the handling of --max-delete=N.
+    - Fixed the accidental disabling of --backup during the --delete-after
+      processing.
 
-    - One fork() call needed to check for and handle a failure.
+    - Restored the ability to use the --address option in client mode (in
+      addition to its use in daemon mode).
 
-  ENHANCEMENTS:
-
-    - 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 for a
-      user to start a daemon that had improper default option values that
-      could cause problems (a hang or an exit) when a client connects.
-
-    - 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.
-
-  BUILD CHANGES:
-
-    - Handle an operating system that use mkdev() in place of makedev().
-
-\f
-NEWS for rsync 2.6.3 (30 Sep 2004)
-Protocol: 28 (unchanged)
-Changes since 2.6.2:
-
-  SECURITY FIXES:
-
-    - A bug in the sanitize_path routine (which affects a non-chrooted
-      rsync daemon) could allow a user to craft a pathname that would get
-      transformed into an absolute path for certain options (but not for
-      file-transfer names).  If you're running an rsync daemon with chroot
-      disabled, *please upgrade*, ESPECIALLY if the user privs you run
-      rsync under is anything above "nobody".
-
-  OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
-
-    - Please note that the 2-line footer (output when verbose) now uses the
-      term "sent" instead of "wrote" and "received" instead of "read".  If
-      you are not parsing the numeric values out of this footer, a script
-      would be better off using the empty line prior to the footer as the
-      indicator that the verbose output is over.
-      
-    - The output from the --stats option was similarly affected to change
-      "written" to "sent" and "read" to "received".
-
-    - Rsync ensures that a filename that contains a newline gets mentioned
-      with each newline transformed into a question mark (which prevents a
-      filename from causing an empty line to be output).
-
-    - The "backed up ..." message that is output when at least 2 --verbose
-      options are specified is now the same both with and without the
-      --backup-dir option.
-
-  BUG FIXES:
-
-    - Fixed a crash bug that might appear when --delete was used and
-      multiple source directories were specified.
-
-    - Fixed a 32-bit truncation of the file length when generating the
-      checksums.
-
-    - 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.
+    - 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.
 
-    - If a file has a read error on the sending side or the reconstructed
-      data doesn't match the expected checksum (perhaps due to the basis
-      file changing during the transfer), the receiver will no longer
-      retain the resulting file unless the --partial option was specified.
-      (Note: for the read-error detection to work, neither side can be
-      older than 2.6.3 -- older receivers will always retain the file, and
-      older senders don't tell the receiver that the file had a read
-      error.)
+    - When --existing skips a directory with extra verbosity, refer to it
+      as a "directory", not a "file".
 
-    - If a file gets resent in a single transfer and the --backup option
-      is enabled, rsync no longer performs a duplicate backup (it used to
-      overwrite the original file in the backup area).
+    - 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.
 
-    - Files specified in the daemon's "exclude" or "exclude from" config
-      items are now excluded from being uploaded (assuming that the module
-      allows uploading at all) in addition to the old download exclusion.
+    - Fixed a bug where hard-linking a group of files might fail if the
+      generator hasn't created a needed destination directory yet.
 
-    - Got rid of a potential hang in the receiver when near the end of a
-      phase.
+    - 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 using --backup without a --backup-dir, rsync no longer preserves
-      the modify time on directories.  This avoids confusing NFS.
+    - 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.
 
-    - When --copy-links (-L) is specified, we now output a separate error
-      for a symlink that has no referent instead of claiming that a file
-      "vanished".
+    - Fixed a compatibility problem when using --cvs-ignore (-C) and
+      sending files to an older rsync without using --delete.
 
-    - The --copy-links (-L) option no longer has the side-effect of telling
-      the receiving side to follow symlinks.  See the --keep-dirlinks
-      option (mentioned below) for a way to specify that behavior.
+    - Make sure that a "- !" or "+ !" include/exclude pattern does not
+      trigger the list-clearing action that is reserved for "!".
 
-    - Error messages from the daemon server's option-parsing (such as
-      refused options) are now successfully transferred back to the client
-      (the server used to fail to send the message because the socket
-      wasn't in the right state for the message to get through).
+    - Avoid a timeout in the generator when the sender/receiver aren't
+      handling the generator's checksum output quickly enough.
 
-    - Most transfer errors that occur during a daemon transfer are now
-      returned to the user in addition to being logged (some messages are
-      intended to be daemon-only and are not affected by this).
+    - Fixed the ommission of some directories in the delete processing when
+      --relative (-R) was combined with a source path that had a trailing
+      slash.
 
-    - Fixed a bug in the daemon authentication code when using one of the
-      batch-processing options.
+    - Make sure that --max-size doesn't affect a device or a symlink.
 
-    - We try to work around some buggy IPv6 implementations that fail to
-      implement IPV6_V6ONLY.  This should fix the "address in use" error
-      that some daemons get when running on an OS with a buggy IPv6
-      implementation.  Also, if the new code gets this error, we might
-      suggest that the user specify --ipv4 or --ipv6 (if we think it will
-      help).
+    - 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.)
 
-    - When the remote rsync dies, make a better effort to recover any error
-      messages it may have sent before dying (the local rsync used to just
-      die with a socket-write error).
+    - 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).
 
-    - When using --delete and a --backup-dir that contains files that are
-      hard-linked to their destination equivalents, rsync now makes sure
-      that removed files really get removed (avoids a really weird rename()
-      behavior).
+    - 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.
 
-    - Avoid a bogus run-time complaint about a lack of 64-bit integers when
-      the int64 type is defined as an off_t and it actually has 64-bits.
+    - If --stats is specified with --delete-after, ensure that all the
+      "deleting" messages are output before the statistics.
 
-    - Added a configure check for open64() without mkstemp64() so that we
-      can avoid using mkstemp() when such a combination is encountered.
-      This bypasses a problem writing out large temp files on OSes such as
-      AIX and HP-UX.
-
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
-
-    - When --dry-run (-n) is used and the destination directory does not
-      exist, rsync now produces a correct report of files that would be
-      sent instead of dying with a chdir() error.
-
-    - Fixed a bug that could cause a slow-to-connect rsync daemon to die
-      with an error instead of waiting for the connection to finish.
-
-    - Fixed an ssh interaction that could cause output to be lost when the
-      user chose to combine the output of rsync's stdout and stderr (e.g.
-      using the "2>&1").
+    - Improved one "if" in the deletion code that was only checking errno
+      for ENOTEMPTY when it should have also been checking for EEXIST.
 
   ENHANCEMENTS:
 
-    - Added the --partial-dir=DIR option that lets you specify where to
-      (temporarily) put a partially transferred file (instead of over-
-      writing the destination file).  E.g.  --partial-dir=.rsync-partial
-      Also added support for the RSYNC_PARTIAL_DIR environment variable
-      that, when found, transforms a regular --partial option (such as
-      the convenient -P option) into one that also specifies a directory.
-
-    - Added --keep-dirlinks (-K), which allows you to symlink a directory
-      onto another partition on the receiving side and have rsync treat it
-      as matching a normal directory from the sender.
-
-    - Added the --inplace option that tells rsync to write each destination
-      file without using a temporary file.  The matching of existing data
-      in the destination file can be severely limited by this, but there
-      are also cases where this is more efficient (such as appending data).
-      Use only when needed (see the man page for more details).
-
-    - Added the "write only" option for the daemon's config file.
-
-    - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
-      and documented all these options in the man page.
-
-    - Improved the handling of the --bwlimit option so that it's less
-      bursty, more accurate, and works properly over a larger range of
-      values.
-
-    - The rsync daemon-over-ssh code now looks for SSH_CONNECTION and
-      SSH2_CLIENT in addition to SSH_CLIENT to figure out the IP address.
+    - 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).
 
-    - Added the --checksum-seed=N option for advanced users.
+    - 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.
 
-    - Batch writing/reading has a brand-new implementation that is simpler,
-      fixes a few weird problems with the old code (such as no longer
-      sprinkling the batch files into different dirs or even onto different
-      systems), and is much less intrusive into the code (making it easier
-      to maintain for the future).  The new code generates just one data
-      file instead of three, which makes it possible to read the batch on
-      stdin via a remote shell.  Also, the old requirement of forcing the
-      same fixed checksum-seed for all batch processing has been removed.
+    - 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.
 
-    - If an rsync daemon has a module set with "list = no" (which hides its
-      presence in the list of available modules), a user that fails to
-      authenticate gets the same "unknown module" error that they would get
-      if the module were actually unknown (while still logging the real
-      error to the daemon's log file).  This prevents fishing for module
-      names.
+    - 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.)
 
-    - The daemon's "refuse options" config item now allows you to match
-      option names using wildcards and/or the single-letter option names.
+    - 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).
 
-    - Each transferred file now gets its permissions and modified-time
-      updated before the temp-file gets moved into place.  Previously, the
-      finished file would have a very brief window where its permissions
-      disallowed all group and world access.
+    - 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).
 
-    - Added the ability to parse a literal IPv6 address in an "rsync:" URL
-      (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
+    - The man pages now consistently refer to an rsync daemon as a "daemon"
+      to distinguish it from a server in a non-daemon transfer.
 
-    - The daemon's wildcard expanding code can now handle more than 1000
-      filenames (it's now limited by memory instead of having a hard-wired
-      limit).
+    - 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).
 
   INTERNAL:
 
-    - Some cleanup in the exclude code has saved some per-exclude memory
-      and made the code easier to maintain.
+    - Rsync now calls setlocale(LC_CTYPE, "") to enable isprint() to better
+      discern which filename characters need to be escaped in messages.
 
-    - Improved the argv-overflow checking for a remote command that has a
-      lot of args.
+    - Improved the naming of the log-file open/reopen/close functions.
 
-    - Use rsyserr() in the various places that were still calling rprintf()
-      with strerror() as an arg.
-
-    - If an rsync daemon is listening on multiple sockets (to handle both
-      IPv4 and IPv6 to a single port), we now close all the unneeded file
-      handles after we accept a connection (we used to close just one of
-      them).
-
-    - Optimized the handling of larger block sizes (rsync used to slow to a
-      crawl if the block size got too large).
-
-    - Optimized away a loop in hash_search().
-
-    - Some improvements to the sanitize_path() and clean_fname() functions
-      makes them more efficient and produce better results (while still
-      being compatible with the file-name cleaning that gets done on both
-      sides when sending the file-list).
-
-    - Got rid of alloc_sanitize_path() after adding a destination-buffer
-      arg to sanitize_path() made it possible to put all the former's
-      functionality into the latter.
-
-    - The file-list that is output when at least 4 verbose options are
-      specified reports the uid value on the sender even when rsync is
-      not running as root (since we might be sending to a root receiver).
+    - Removed some protocol compatibility code that was only needed to help
+      someone running a pre-release of 2.6.4.
 
   BUILD CHANGES:
 
-    - Added a "gen" target to rebuild most of the generated files,
-      including configure, config.h.in, the man pages, and proto.h.
-
-    - If "make proto" doesn't find some changes in the prototypes, the
-      proto.h file is left untouched (its time-stamp used to always be
-      updated).
-
-    - The variable $STRIP (that is optionally set by the install-strip
-      target's rule) was changed to $INSTALL_STRIP because some systems
-      have $STRIP already set in the environment.
-
-    - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
+    - Fixed a bug in the SUPPORT{,_HARD}_LINKS defines which prevented
+      rsync from being built without symlink or hard-link support.
 
-    - When cross-compiling, the gettimeofday() function is now assumed to
-      be a modern version that takes two-args (since we can't test it).
+    - You can use --disable-locale to turn off any use of setlocale().
 
-  DEVELOPER RELATED:
+    - Configure now disables the use of mkstemp() under HP-UX (since they
+      refuse to fix its broken handling of large files).
 
-    - The scripts in the testsuite dir were cleaned up a bit and a few
-      new tests added.
+    - 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 new diffs were added to the patches dir, and some accepted
-      ones were removed.
+    - Some minor enhancements to the test scripts.
 
+    - Added a few new diffs to the patches dir, including a patch that
+      enables the optional copying of extended attributes.