Call flush_write_file() in _exit_cleanup() if we are keeping a
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index a93bbfa..23238c5 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync version 2.6.0
-Protocol: 27 (changed)
-Changes since version 2.5.7:
-
-  ENHANCEMENTS:
-
-    * "ssh" is now the default remote shell for rsync.  If you want to
-      change this, configure like this:  "./configure --with-rsh=rsh".
-
-    * 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)
-
-    * Length of csum2 is now per-file starting with protocol verison
-      27. (J.W. Schultz)
-
-    * Per-file dynamic block size is now sqrt(file length).
-      The per-file checksum size is determined according
-      to an algorythm 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.
+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 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.
+    - Fixed a crash bug that might appear when --delete was used and
+      multiple source directories were specified.
 
-      - "**/foo" now matches at the base of the transfer (i.e. /foo).
+    - Fixed a 32-bit truncation of the file length when generating the
+      checksums.
 
-      - An 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.
+    - The --backup code no longer attempts to create some directories
+      over and over again (generating warnings along the way).
 
-      - 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" (for instance).
+    - 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.
 
-    * 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)
+    - 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.)
 
-    * 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)
+    - 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).
 
-    * 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)
+    - 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 crash bug when interacting with older rsync versions and
-      multiple files of the same name are destined for the same dir.
-      (Wayne Davison)
+    - Got rid of a potential hang in the receiver when near the end of a
+      phase.
 
-    * Keep tmp names from overflowing MAXPATHLEN.
+    - When using --backup without a --backup-dir, rsync no longer preserves
+      the modify time on directories.  This avoids confusing NFS.
 
-    * Make --link-dest honor the absence of -p, -o, and -g.
+    - 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".
 
-    * Made rsync treat a trailing slash in the destination in a more
-      consistent manner.
+    - 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.
 
-    * Fixed file I/O error detection.  (John Van Essen)
+    - 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).
 
-    * 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.
+    - 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).
 
-    * Print heap statistics when verbose >= 2 instead of when >= 1.
+    - Fixed a bug in the daemon authentication code when using one of the
+      batch-processing options.
 
-    * Fixed a compression (-z) bug when syncing a mostly-matching file
-      that contains already-compressed data.  (Yasuoka Masahiko and
-      Wayne Davison)
+    - 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).
 
-    * Fixed a bug in the --backup code that could cause deleted files
-      to not get backed up.
+    - 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).
 
-    * Call setgroups() in a more portable manner.
+    - 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).
 
-    * Improved file-related error messages to better indicate exactly
-      what pathname failed. (Wayne Davison)
+    - 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.
 
-    * Fixed some bugs in the handling of --delete and --exclude when
-      using the --relative (-R) option. (Wayne Davison)
+    - 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 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)
+    - Fixed an age-old crash problem with --read-batch on a local copy
+      (rsync was improperly assuming --whole-file for the local copy).
 
-    * Detect and report when open or opendir succeed but read and
-      readdir fail caused by network filesystems issues and truncated
-      files.  (David Norwood, Michael Brown, J.W. Schultz)
+    - 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.
 
-    * Added a fix that should give ssh time to restore the tty settings
-      if the user presses Ctrl-C at an ssh password prompt.
-
-  INTERNAL:
+    - 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.
 
-    * Eliminated vestigial support for old versions that we stopped
-      supporting. (J.W. Schultz)
+    - 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").
 
-    * Simplified some of the option-parsing code. (Wayne Davison)
-
-    * Some cleanup made to the exclude code, as well as some new
-      defines added to enhance readability. (Wayne Davison)
-
-    * 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)
-
-
-NEWS for rsync version 2.5.7:
-Protocol: 26 (unchanged)
-Changes since version 2.5.6:
-
-  SECURITY:
+  ENHANCEMENTS:
 
-    * Fix buffer handling bugs.  (Andrew Tridgell, Martin Pool, Paul
-      Russell, Andrea Barisani)
+    - 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.
 
-NEWS for rsync version 2.5.6, aka the dwd-between-jobs release
-Protocol: 26 (unchanged)
-Changes since version 2.5.5:
+    - 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).
 
-  ENHANCEMENTS:
+    - Added the "write only" option for the daemon's config file.
 
-    * The --delete-after option now implies --delete.  (Wayne Davison)
+    - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
+      and documented all these options in the man page.
 
-    * The --suffix option can now be used with --backup-dir.  (Michael
-      Zimmerman)
+    - Improved the handling of the --bwlimit option so that it's less
+      bursty, more accurate, and works properly over a larger range of
+      values.
 
-    * Combining "::" syntax with the -rsh/-e option now uses the
-      specified remote-shell as a transport to talk to a (newly-spawned)
-      server-daemon.  This allows someone to use daemon features, such
-      as modules, over a secure protocol, such as ssh.  (JD Paul)
+    - 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.
 
-    * The rsync:// syntax for daemon connections is now accepted in the
-      destination field.
+    - Added the --checksum-seed=N option for advanced users.
 
-    * If the file name given to --include-from or --exclude-from is "-",
-      rsync will read from standard input.  (J.W. Schultz)
+    - 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.
 
-    * New option --link-dest which is like --compare-dest except that
-      unchanged files are hard-linked in to the destination directory.
-      (J.W. Schultz)
+    - 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.
 
-    * Don't report an error if an excluded file disappears during an
-      rsync run.  (Eugene Chupriyanov and Bo Kersey)
+    - The daemon's "refuse options" config item now allows you to match
+      option names using wildcards and/or the single-letter option names.
 
-    * Added .svn to --cvs-exclude list to support subversion.  (Jon
-      Middleton)
+    - 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.
 
-    * Properly support IPv6 addresses in the rsyncd.conf "hosts allow"
-      and "hosts deny" fields.  (Hideaki Yoshifuji)
+    - Added the ability to parse a literal IPv6 address in an "rsync:" URL
+      (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
 
-    * Changed exclude file handling to permit DOS or MAC style line
-      terminations.  (J.W. Schultz)
+    - 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).
 
-    * Ignore errors from chmod when -p/-a/--preserve-perms is not set.
-      (Dave Dykstra)
+  INTERNAL:
 
-  BUG FIXES:
+    - Some cleanup in the exclude code has saved some per-exclude memory
+      and made the code easier to maintain.
 
-    * Fix "forward name lookup failed" errors on AIX 4.3.3.  (John
-      L. Allen, Martin Pool)
+    - Improved the argv-overflow checking for a remote command that has a
+      lot of args.
 
-    * Generate each file's rolling-checksum data as we send it, not
-      in a separate (memory-eating) pass before hand.  This prevents
-      timeout errors on really large files. (Stefan Nehlsen)
+    - Use rsyserr() in the various places that were still calling rprintf()
+      with strerror() as an arg.
 
-    * Fix compilation on Tru64.  (Albert Chin, Zoong Pham)
+    - 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).
 
-    * Better handling of some client-server errors.  (Martin Pool)
+    - Optimized the handling of larger block sizes (rsync used to slow to a
+      crawl if the block size got too large).
 
-    * Fixed a crash that would occur when sending a list of files that
-      contains a duplicate name (if it sorts to the end of the file
-      list) and using --delete.  (Wayne Davison)
+    - Optimized away a loop in hash_search().
 
-    * Fixed the file-name duplicate-removal code when dealing with multiple
-      dups in a row. (Wayne Davison)
+    - 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).
 
-    * Fixed a bug that caused rsync to lose the exit status of its child
-      processes and sometimes return an exit code of 0 instead of showing
-      an error.  (David R. Staples, Dave Dykstra)
+    - 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.
 
-    * Fixed bug in --copy-unsafe-links that caused it to be completely
-      broken.  (Dave Dykstra)
+    - 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).
 
-    * Prevent infinite recursion in cleanup code under certain circumstances.
-      (Sviatoslav Sviridov and Marc Espie)
+  BUILD CHANGES:
 
-    * Fixed a bug that prevented rsync from creating intervening directories
-      when --relative-paths/-R is set.  (Craig Barratt)
+    - Added a "gen" target to rebuild most of the generated files,
+      including configure, config.h.in, the man pages, and proto.h.
 
-    * Prevent "Connection reset by peer" messages from Cygwin. (Randy O'Meara)
+    - 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).
 
-  INTERNAL:
+    - 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.
 
-    * Many code cleanups and improved internal documentation.  (Martin
-      Pool, Nelson Beebe)
+    - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
 
-    * Portability fixes. (Dave Dykstra and Wayne Davison)
+    - When cross-compiling, the gettimeofday() function is now assumed to
+      be a modern version that takes two-args (since we can't test it).
 
-    * More test cases.  (Martin Pool)
+  DEVELOPER RELATED:
 
-    * Some test-case fixes.  (Brian Poole, Wayne Davison)
+    - The scripts in the testsuite dir were cleaned up a bit and a few
+      new tests added.
 
-    * Updated included popt to the latest vendor drop, version 1.6.4.
-      (Jos Backus)
+    - Some new diffs were added to the patches dir, and some accepted
+      ones were removed.
 
-    * Updated config.guess and config.sub to latest versions; this
-      means rsync should build on more platforms.  (Paul Green)