Mention files-to-excludes.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 900eb78..f656a53 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.7 (UNRELEASED)
+Protocol: 29 (unchanged)
+Changes since 2.6.6:
 
-  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).
-
-    - Avoid a mkdir warning when removing a directory in the destination
-      that already exists in the --backup-dir.
-
-    - 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().
-
-    - 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 an off-by-one error in the handling of --max-delete=N.
-
-    - One fork() call needed to check for and handle a failure.
-
-  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:
+  OUTPUT 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.
+    - The itemized output now uses 'S' for a special file instead of
+      clumping them together with the 'D' for devices.  The number of
+      characters is also different (to remove an unused field).
 
   BUG FIXES:
 
-    - Fixed a crash bug that might appear when --delete was used and
-      multiple source directories were specified.
+    - Fixed a really old bug that caused --checksum (-c) to checksum all the
+      files encountered during the delete scan (ouch).
 
-    - Fixed a 32-bit truncation of the file length when generating the
-      checksums.
+    - Made hard-links work with symlinks and devices again.
 
-    - The --backup code no longer attempts to create some directories
-      over and over again (generating warnings along the way).
+    - If the sender gets an early EOF reading a source file, we propagate this
+      error to the receiver so that it can discard the file and try requesting
+      it again (which is the existing behavior for other kinds of read errors).
 
-    - 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.
+    - If a device-file/special-file changes permissions, rsync now updates the
+      permissions without recreating the file.
 
-    - 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 the user specifies a remote-host for both the source and destination,
+      we now output a syntax error rather than trying to open the destination
+      hostspec as a filename.
 
-    - 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 --inplace creates a new destination file, rsync now creates it with
+      permissions 0600 instead of 0000 -- this makes restarting possible when
+      the transfer gets interrupted in the middle of sending a new file.
 
-    - 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.
+    - Reject the combination of --inplace and --sparse since the sparse-output
+      algorithm doesn't work when overwriting existing data.
 
-    - Got rid of a potential hang in the receiver when near the end of a
-      phase.
+    - Fixed the directory name in the error that is output when pop_dir()
+      fails.
 
-    - When using --backup without a --backup-dir, rsync no longer preserves
-      the modify time on directories.  This avoids confusing NFS.
+    - Really fixed the parsing of a "!" entry in .cvsignore files this time.
 
-    - 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".
+    - If the generator gets a stat() error on a file, output it (this used to
+      require at least -vv for the error to be seen).
 
-    - 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.
+    - If waitpid() fails or the child rsync didn't exit cleanly, we now handle
+      the exit status properly and generate a better error.
 
-    - 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 some glitches in the double-verbose output when using --copy-dest,
+      --link-dest, or --compare-dest.
 
-    - 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 matching of the dont-compress items (e.g. *.gz) against files
+      that have a path component containing a slash.
 
-    - Fixed a bug in the daemon authentication code when using one of the
-      batch-processing options.
+    - If code reading a filter/exclude file an EINTR error, rsync now clears
+      the error flag on the file handle so it can keep on reading.
 
-    - 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).
+    - If --relative is active, the sending side cleans up trailing "/" or "/."
+      suffixes to avoid triggering a bug in older rsync versions.  Also, we now
+      reject a ".." dir if it would be sent as a relative dir.
 
-    - 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 non-directory is in the way of a directory and rsync is run with
+      --dry-run and --delete, rsync no longer complains about not being able
+      to opendir() the not-yet present directory.
 
-    - 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).
+    - Got rid of the need for --force to be used in some circumstances with
+      --delete-after (making it consistent with --delete-before/-during).
 
-    - 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.
-
-    - 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.
+  ENHANCEMENTS:
 
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
+    - Added the --specials option to tell rsync to copy special files (and does
+      not require root).  The --devices option now affects just character and
+      block devices (which now matches the documentation).  The -D option still
+      requests both --devices and --specials, and -a still implies -D.
 
-    - 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 the --append option that makes rsync append data onto files that
+      are longer on the source than the destination (this includes new files).
 
-    - 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.
+    - Added the --min-size=SIZE option to exclude small files from the
+      transfer.
 
-    - 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").
+    - Added the --compress-level option to allow you to set how aggressive
+      rsync's compression should be (this option implies --compress).
 
-  ENHANCEMENTS:
+    - Enhanced the parsing of the SIZE value for --min-size and --max-size to
+      allow easy entry of multiples of 1000 (instead of just multiples of 1024)
+      and off-by-one values too (e.g. --max-size=8mb-1).
 
-    - 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.
+    - The options --human-readable (-h) and --si change the output of the
+      --stats and the end-of-run summary to be easier to read.
 
-    - 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.
+    - If lutimes() and/or lchmod() are around, use them to allow the
+      preservation of attributes on symlinks.
 
-    - 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).
+    - The --link-dest option now affects symlinks and devices (when possible).
 
-    - Added the "write only" option for the daemon's config file.
+    - Improved the output of hard-linked and copied files when using
+      --link-dest, --copy-dest, or --compare-dest.
 
-    - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
-      and documented all these options in the man page.
+    - Added two config items to the rsyncd.conf parsing:  "pre-xfer exec" and
+      "post-xfer exec".  These allow a command to be specified on a per-module
+      basis that will be run before and/or after a daemon-mode transfer.  (See
+      the manpage for a list of the environment variables that are set with
+      information about the transfer.)
 
-    - Improved the handling of the --bwlimit option so that it's less
-      bursty, more accurate, and works properly over a larger range of
-      values.
+    - When using the --relative option, you can now insert a dot dir in
+      the source path to indicate where the replication of the source dirs
+      should start.  For example, if you specify a source path of
+      rsync://host/module/foo/bar/./baz/dir with -R, rsync will now only
+      replicate the "baz/dir" part of the source path (note: a trailing
+      dot dir is unaffected unless it also has a trailing slash).
 
-    - 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 some new --no-FOO options that make it easier to override unwanted
+      implied or default options.  For example, "-a --no-o" (aka "--archive
+      --no-owner") can be used to turn off the preservation of file ownership
+      that is implied by -a.
 
-    - Added the --checksum-seed=N option for advanced users.
+    - Added the --chmod=MODE option that allows the destination permissions to
+      be changed from the source permissions.  E.g. --chmod=g+w,o-rwx
 
-    - 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.
+    - Added the "incoming chmod" and "outgoing chmod" daemon options that allow
+      a module to specify what permissions changes should be applied to all
+      files copied to and from the daemon.
 
-    - 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.
+    - Allow the --temp-dir option to be specified when starting a daemon, which
+      sets the default temporary directory for incoming files.
 
-    - The daemon's "refuse options" config item now allows you to match
-      option names using wildcards and/or the single-letter option names.
+    - If --delete is combined with --dirs without --recursive, rsync will now
+      delete in any directory whose content is being synchronized.
 
-    - 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 --backup is combined with --delete without --backup-dir (and without
+      --delete-excluded), we add a "protect" filter-rule to ensure that files
+      with the backup suffix are not deleted.
 
-    - 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 file-count stats that are output by --progress were improved to
+      better indicate what the numbers mean.  For instance, the output:
+      "(xfer#5, to-check=8383/9999)" indicates that this was the fifth file
+      to be transferred, and we still need to check 8383 more files out of
+      a total of 9999.
 
-    - 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).
+    - The include/exclude code now allows a dir/*** directive (with 3 trailing
+      stars) to match both the dir itself as well as all the content below the
+      dir (dir/** would not match the dir).
 
-  INTERNAL:
+    - Added the --prune-empty-dirs (-m) option that makes the receiving rsync
+      discard empty chains of directories from the file-list.  This makes it
+      easier to selectively copy files from a source hierarchy and end up with
+      just the directories needed to hold the resulting files.
 
-    - Some cleanup in the exclude code has saved some per-exclude memory
-      and made the code easier to maintain.
+    - If the --itemize-changes (-i) option is repeated, rsync now includes
+      unchanged files in the itemized output (similar to -vv, but without all
+      the other verbose messages that can get in the way).  Of course, the
+      client must be version 2.6.7 for this to work, but the remote rsync only
+      needs to be 2.6.7 if you're pushing files.
 
-    - Improved the argv-overflow checking for a remote command that has a
-      lot of args.
+    - Added the --super option to make the receiver always attempt super- user
+      activities.  This is useful for systems that allow things such as devices
+      to be created or ownership to be set without being UID 0, and is also
+      useful for someone who wants to ensure that errors will be output if the
+      receiving rsync isn't being run as root.
 
-    - Use rsyserr() in the various places that were still calling rprintf()
-      with strerror() as an arg.
+    - Added the --sockopts option for those few who want to customize the TCP
+      options used to contact a daemon rsync.
 
-    - 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).
+    - Added a way for the --temp-dir option to be combined with a partial-dir
+      setting that lets rsync avoid non-atomic updates (for those times when
+      --temp-dir is not being used because space is tight).
 
-    - Optimized the handling of larger block sizes (rsync used to slow to a
-      crawl if the block size got too large).
+    - Some minor documentation improvements.
 
-    - Optimized away a loop in hash_search().
+    - Updated some diffs in the patches dir.
 
-    - 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).
+    - A new support script, files-to-excludes, will transform a list of files
+      into a set of include/exclude directives that will copy those files.
 
-    - 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.
+  INTERNAL:
 
-    - 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).
+    - Some buffer sizes were expanded a bit, particularly on systems where
+      MAXPATHLEN is overly small (e.g. cygwin).
 
-  BUILD CHANGES:
+    - If io_printf() tries to format more data than fits in the buffer, exit
+      with an error instead of transmitting a truncated buffer.
 
-    - Added a "gen" target to rebuild most of the generated files,
-      including configure, config.h.in, the man pages, and proto.h.
+    - If a va_copy macro is defined, lib/snprintf.c will use it when defining
+      the VA_COPY macro.
 
-    - 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).
+    - Reduced the amount of stack memory needed for each level of directory
+      recursion by nearly MAXPATHLEN bytes.
 
-    - 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.
+    - The wildmatch function was extended to allow an array of strings to be
+      supplied as the string to match.  This allows the exclude code to do less
+      string copying.
 
-    - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
+    - Got rid of the safe_fname() function (and all the myriad calls) and
+      replaced it with a new function in the log.c code that filters all the
+      output going to the terminal.
 
-    - When cross-compiling, the gettimeofday() function is now assumed to
-      be a modern version that takes two-args (since we can't test it).
+    - Unified the f_name() and the f_name_to() functions.
 
   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.
+    - Several diffs in the patches dir now use the proper --enable-FOO
+      configure option instead of --with-FOO to turn on the inclusion of
+      the newly patched feature.
 
+    - The testsuite now sets HOME so that it won't be affecting by a file
+      such as ~/.popt.