Implemented a "!" modifier for filter rules that lets a rule trigger
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index aa697dc..31b1f96 100644 (file)
--- a/NEWS
+++ b/NEWS
-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.
+NEWS for rsync 2.6.4 (UNRELEASED)
+Protocol: 29 (changed)
+Changes since 2.6.3:
 
-  BUG FIXES:
-
-    - Fixed a crash bug that might appear when --delete was used and
-      multiple source directories were specified.
-
-    - Fixed the 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).
+  OUTPUT CHANGES:
 
-    - 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.
+    - 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.
 
-    - 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.)
-
-    - 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).
-
-    - 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.
+    - 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).
+  
+  BUG FIXES:
 
-    - Got rid of a potential hang in the receiver when near the end of a
-      phase.
+    - 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).
 
-    - When using --backup without a --backup-dir, rsync no longer preserves
-      the modify time on directories.  This avoids confusing NFS.
+    - The --dry-run option (-n) now mentions changes in directories (w/-v).
+      It also now includes the normal uptodate output information for -vv.
 
-    - 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".
+    - Avoid a mkdir warning when removing a directory in the destination
+      that already exists in the --backup-dir.
 
-    - 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.
+    - 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 rsync package.)
 
-    - Error messages from the daemon server's option-parsing (such as
-      refused options) now get sent back to the client (the server used
-      to just exit because the socket wasn't in the right state to send
-      the message).
+    - Fixed a potential hang when verbosity is high, the client side is
+      the sender, and the file-list is large.
 
-    - Most 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).
+    - 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.
 
-    - Fixed a bug in the daemon authentication code when using one of the
-      batch-processing options.
+    - Fixed an off-by-one error in the handling of --max-delete=N.
 
-    - 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).
+    - One place in the code wasn't checking if fork() failed.
 
-    - 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).
+    - The "ignore nonreadable" daemon parameter no longer affects symlinks
+      that are being copied, even if they point nowhere.
 
-    - 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 (works around a really weird
-      rename() behavior).
+    - 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.
 
-    - 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.
+    - 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.
 
-    - 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.
+    - 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.
 
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
+    - One call to flush_write_file() was not being checked for an error.
 
-    - 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.
+    - The --no-relative option was not being sent from the client to a
+      server sender.
 
-    - 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.
+    - 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).
 
-    - 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").
+    - If a daemon can't open the specified log file (i.e. syslog is not
+      being used), die without crashing.  We also try to output an error
+      about the failure (which will only be seen if --no-detach was
+      specified).
 
   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 --checksum-seed=N option for advanced users.
-
-    - 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.
-
-    - 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.
-
-    - The daemon's "refuse options" config item now allows you to match
-      option names using wildcards and/or the single-letter option names.
-
-    - 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.
-
-    - Added the ability to parse a literal IPv6 address in an "rsync:" URL
-      (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
+    - 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 (which makes it more efficient than the
+      default, before-the-transfer behavior of --delete).  Note that the
+      --del option is implemented as an internally-defined popt alias, so
+      an rsync daemon that refuses "delete" (which, for safety's sake,
+      really matches "delete*") will still refuse all delete options.  The
+      default --delete behavior is also explicitly selectable via
+      --delete-before.
+
+    - 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 a single 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 (such as 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".
+
+    - 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.
+
+    - 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
+      option kluges (e.g. the age-old use of "-r --exclude="/*/*" for a
+      non-recursive listing).  This option is used automatically 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.
+
+    - 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.
+
+    - 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.)
+
+  SUPPORT FILES:
+
+    - Added support/atomic-rsync -- 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 support/mnt-excl 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 support/savetransfer.c -- 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 support/rrsync -- 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.
+
+    - Improved the option descriptions in the --help text.
 
   INTERNAL:
 
-    - Some cleanup in the exclude code has saved some per-exclude memory
-      and made the code easier to maintain.
-
-    - Improved the argv-overflow checking for a remote command that has a
-      lot of args.
-
-    - Use rsyserr() in the various places that were still calling rprintf()
-      with strerror() as an arg.
+    - Added better checking of the checksum-header values that come over
+      the socket.
 
-    - 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).
+    - Merged the various delete-file functions into a single function so
+      that it is easier to maintain.
 
-    - Optimized the handling of larger block sizes (rsync used to slow to a
-      crawl if the block size got too large).
+    - Improved the type of some variables (particularly blocksize vars) for
+      consistency and proper size.
 
-    - Optimized away a loop in hash_search().
+    - Got rid of the uint64 type (which we didn't need).
 
-    - 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).
+    - Use a slightly more compatible set of core #include directives.
 
-    - 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).
+    - Defined int32 in a way that ensures that the build dies if we can't
+      find a variable with at least 32 bits.
 
   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 set in the environment.
-
-    - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
-
-  DEVELOPER RELATED:
-
-    - The scripts in the testsuite dir were cleaned up a bit and a few
-      new tests added.
-
-    - Some new diffs were added to the patches dir, and some accepted
-      ones were removed.
+    - Handle an operating system that use mkdev() in place of makedev().
 
+    - Improved configure to better handle cross-compiling.