Preparing for release of 3.0.0pre1
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index b5633fb..f45d762 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.7 (UNRELEASED)
-Protocol: 29 (unchanged)
-Changes since 2.6.6:
-
-  OUTPUT CHANGES:
-
-    - 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).
-
-    - The way rsync escapes unreadable characters has changed.  First, rsync
-      now has support for recognizing valid multibyte character sequences in
-      your current locale, allowing it to escape fewer characters than before
-      for a locale such as UTF-8.  Second, it now uses an escape idiom of
-      "\#123", which is the literal string "\#" followed by exactly 3 octal
-      digits.  Rsync no longer doubles a backslash character in a filename
-      (e.g. it used to output "foo\\bar" when copying "foo\bar") -- now it only
-      escapes a backslash that is followed by a hash-sign and 3 digits (0-9)
-      (e.g. it will output "foo\#134#789" when copying "foo\#789").  See also
-      the --8-bit-output (-8) option, mentioned below.
-
-      Script writers: the local rsync is the one that outputs escaped names,
-      so if you need to support unescaping of filenames for older rsyncs, I'd
-      suggest that you parse the output of "rsync --version" and only use the
-      old unescaping rules for 2.6.5 and 2.6.6.
+NEWS for rsync 3.0.0 (UNRELEASED)
+Protocol: 30 (changed)
+Changes since 2.6.9:
 
-  BUG FIXES:
-
-    - Fixed a really old bug that caused --checksum (-c) to checksum all the
-      files encountered during the delete scan (ouch).
+  NOTABLE CHANGE IN BEHAVIOR:
 
-    - Fixed a potential hang in a remote generator:  when the receiver gets a
-      read-error on the socket, it now signals the generator about this so that
-      the generator does not try to send any of the terminating error messages
-      to the client (avoiding a potential hang in some setups).
+   - The handling of implied directories when using --relative has changed
+     to send them as directories (e.g. no implied dir is ever sent as a
+     symlink).  This avoids unexpected behavior and should not adversely
+     affect most people.  If you're one of those rare people who relied
+     upon having an implied dir be duplicated as a symlink, either specify
+     --keep-dirlinks or --no-implied-dirs.
 
-    - Made hard-links work with symlinks and devices again.
+  BUG FIXES:
 
-    - 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 the output of -ii when combined with one of the --*-dest options:
+      it now itemizes all the items, not just the changed ones.
 
-    - If a device-file/special-file changes permissions, rsync now updates the
-      permissions without recreating the file.
+    - Made the output of all file types consistent when using a --*-dest
+      option.  Prior versions used to output too many creation events for
+      matching items.
 
-    - 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.
+    - The code that waits for a child pid now handles being interrupted by a
+      signal.  This fixes a problem with the pre-xfer exec function not being
+      able to get the exit status from the script.
 
-    - 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.
+    - A negated filter rule (with a '!' modifier) no longer loses the negation
+      when sending the filter rules to the remote rsync.
 
-    - Reject the combination of --inplace and --sparse since the sparse-output
-      algorithm doesn't work when overwriting existing data.
+    - Fixed a problem with the --out-format (aka --log-format) option %f:  it
+      would output superfluous directory information for a non-daemon rsync.
 
-    - Fixed the directory name in the error that is output when pop_dir()
-      fails.
+    - Fixed a problem with -vv (double --verbose) and --stats when "pushing"
+      files (which includes local copies).  Version 2.6.9 would complete the
+      copy, but exit with an error when the receiver output its memory stats.
 
-    - Really fixed the parsing of a "!" entry in .cvsignore files this time.
+    - If --password-file is used on a non-daemon transfer, rsync now complains
+      and exits.  This should help users figure out that they can't use this
+      option to control a remote shell's password prompt.
 
-    - 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).
+    - Make sure that directory permissions of a newly-created destination
+      directory are handled right when --perms is left off.
 
-    - If waitpid() fails or the child rsync didn't exit cleanly, we now handle
-      the exit status properly and generate a better error.
+    - The itemized output of a newly-created destination directory is now
+      output as a creation event, not a change event.
 
-    - Fixed some glitches in the double-verbose output when using --copy-dest,
-      --link-dest, or --compare-dest.
+    - Improved --hard-link so that more corner cases are handled correctly
+      when combined with options such as --link-dest and/or --ignore-existing.
 
-    - Fixed the matching of the dont-compress items (e.g. *.gz) against files
-      that have a path component containing a slash.
+    - The --append option no longer updates a file that has the same size.
 
-    - 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.
+    - Fixed a bug when combining --backup and --backup-dir with --inplace:
+      any missing backup directories are now created.
 
-    - 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.
+    - Fixed a bug when using --backup and --inplace with --whole-file or
+      --read-batch: backup files are actually created now.
 
-    - 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.
+    - Starting up an extra copy of an rsync daemon does not delete the pidfile
+      for the running daemon -- if the pidfile exists, the extra program will
+      exit with an error.
 
-    - Got rid of the need for --force to be used in some circumstances with
-      --delete-after (making it consistent with --delete-before/-during).
+    - The daemon pidfile is checked and created sooner in the startup sequence.
 
   ENHANCEMENTS:
 
-    - 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.
-
-    - Added the --append option that makes rsync append data onto files that
-      are longer on the source than the destination (this includes new files).
-
-    - Added the --min-size=SIZE option to exclude small files from the
-      transfer.
-
-    - Added the --compress-level option to allow you to set how aggressive
-      rsync's compression should be (this option implies --compress).
-
-    - 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 --8-bit-output (-8) option, which tells rsync to avoid escaping
-      high-bit characters that it thinks are unreadable in the current locale.
-
-    - The new option --human-readable (-h) changes the output of --progress,
-      --stats, and the end-of-run summary to be easier to read.  If repeated,
-      the units become powers of 1024 instead of powers of 1000.
-
-    - If lutimes() and/or lchmod() are around, use them to allow the
-      preservation of attributes on symlinks.
-
-    - The --link-dest option now affects symlinks and devices (when possible).
-
-    - Improved the output of hard-linked and copied files when using
-      --link-dest, --copy-dest, or --compare-dest.
-
-    - 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.)
-
-    - 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).
-
-    - 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 --chmod=MODE option that allows the destination permissions to
-      be changed from the source permissions.  E.g. --chmod=g+w,o-rwx
-
-    - 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.
+    - A new incremental-recursion algorithm is now used when rsync is talking
+      to another 3.x version.  This starts the transfer going more quickly
+      (before all the files have been found), and requires much less memory.
+      See the --recursive option in the manpage for some restrictions.
+
+    - Saved memory in the non-incremental-recursion algorithm for typical
+      option values (usually saving from 21-29 bytes per file).
+
+    - The default --delete algorithm is now --delete-during when talking to a
+      3.x rsync.  This is a faster scan than using --delete-before (which is
+      the default when talking to older rsync versions), and is compatible with
+      the new incremental recursion mode.
+
+    - Rsync now allows multiple remote-source args to be specified rather than
+      having to rely on a special space-splitting side-effect of the remote-
+      shell.  Additional remote args must specify the same host or have an
+      empty hostname, as seen here:  :file1  ::module/file2.  This means that
+      local use of brace expansion now works:  rsync -av host:path/{f1,f2} .
+
+    - Added the --delete-delay option, which is a more efficient way to delete
+      files at the end of the transfer without needing a separate delete pass.
+
+    - Added the --acls (-A) option to preserve Access Control Lists.  This is
+      an improved version of the prior patch that was available, and it even
+      supports OS X ACLs.  (If you need to have backward compatibility with
+      old, patched versions of rsync, apply the acls.diff file from the patches
+      dir.)
+
+    - Added the --xattrs (-X) option to preserver extended attributes.  This is
+      an improved version of the prior patch that was available.  (If you need
+      to have backward compatibility with old, patched versions of rsync, apply
+      the xattrs.diff file from the patches dir.)
+
+    - Added the --fake-super option that allows a non-super user to preserve
+      all attributes of a file by using a special extended-attribute idiom.
+      There is also an analogous "fake super" option for an rsync daemon.
+
+    - Added the --iconv option, which allows rsync to convert filenames from
+      one character-set to another during the transfer.  The default is to make
+      this feature available as long as your system has iconv_open().  If
+      compilation fails, specify --disable-iconv to configure, and then
+      rebuild.  If you want rsync to perform character-set conversions by
+      default, you can specify --enable-iconv=CONVERT_STRING with the default
+      value for the --iconv option that you wish to use.  For example,
+      --enable-iconv=. is a good choice.  See the rsync manpage for an
+      explanation of the --iconv option's settings.
+
+    - Added the --skip-compress=LIST option to override of the default list of
+      file suffixes that will not be compressed when using --compress.
+      
+    - The daemon's default for "dont compress" was extended to include:
+         *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
+      The matching routine was also optimized to run more quickly.
+
+    - The --max-delete option now outputs a warning if it skipped any file
+      deletions, including a count of how many deletions were skipped.  (Older
+      versions just silently stopped deleting things.)
+
+    - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
+      about extraneous files without deleting anything.  If you're not sure
+      what version the client is, you can use the less-obvious --max-delete=-1,
+      as both old and new versions will treat that as the same request (though
+      older versions don't warn).
+
+    - The --hard-link option now uses less memory on both the sending and
+      receiving side for all protocol versions.  For protocol 30, the use of a
+      hashtable on the sending side allows us to more efficiently convey to the
+      receiver what files are linked together.  This reduces the amount of data
+      sent over the socket by a considerable margin (rather than adding more
+      data), and limits the in-memory storage of the device+inode information
+      to just the sending side for the new protocol 30, or to the receiving
+      side when speaking an older protocol (note that older rsync versions kept
+      the device+inode information on both sides).
+
+    - The filter rules now support a perishable ("p") modifier that marks rules
+      that should not have an effect in a directory that is being deleted.  e.g.
+      -f '-p .svn/' would only affect "live" .svn directories.
+
+    - If we get an error setting the time on a symlink, we don't complain about
+      it anymore (since some operating systems don't support that, and it's not
+      that important).
+
+    - Protocol 30 now uses MD5 checksums instead of MD4.
+
+    - If a daemon module's "path" value is not an absolute pathname, the code
+      now makes it absolute internally (making it work properly).
+
+    - Changed the --append option to not checksum the existing data in the
+      destination file, which speeds up file appending.
+
+    - Added the --append-verify option, which works like the older --append
+      option (verifying the existing data in the destination file).  For
+      compatibility with older rsync versions, any use of --append that is
+      talking protocol 29 or older will revert to the --append-verify method.
+
+    - Documented and extended the support for the RSYNC_CONNECT_PROG variable
+      that can be used to enhance the client side of a daemon connection.
+
+    - Added the --protect-args (-s) option, that tells rsync to send most of
+      the command-line args at the start of the transfer rather than as args
+      to the remote-shell command.  This protects them from space-splitting,
+      and only interprets basic wildcard special shell characters (*?[).
+
+    - Improved the dashes and double-quotes in the nroff manpage output.
+
+    - We now support a lot more --no-OPTION override options.
 
-    - Allow the --temp-dir option to be specified when starting a daemon, which
-      sets the default temporary directory for incoming files.
-
-    - If --delete is combined with --dirs without --recursive, rsync will now
-      delete in any directory whose content is being synchronized.
-
-    - 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.
-
-    - 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 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).
-
-    - 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.
-
-    - 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.
-
-    - 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.
-
-    - Added the --sockopts option for those few who want to customize the TCP
-      options used to contact a daemon rsync.
-
-    - 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).
-
-    - 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.
-
-    - A new option, --executability (-E) can be used to preserve just the
-      execute bit on files, for those times when using the --perms option is
-      not desired.
-
-    - The daemon now logs each module-list request it receives.
-
-    - New log-format options: %M (modtime), %U (uid), %G (gid), and %B
-      (permission bits, e.g. "rwxr-xrwt").
+  INTERNAL:
 
-    - The --dry-run option no longer forces the enabling of --verbose.
+    - The file-list sorting algorithm now uses a sort that keeps any same-
+      named items in the same order as they were specified.  This allows
+      rsync to always ensure that the first of the duplicates is the one
+      that will be included in the copy.  The new sort was also faster
+      than the glibc version of qsort() and mergesort() in my testing.
 
-    - Some minor documentation improvements.
+    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
 
-    - Updated some diffs in the patches dir.
+    - Fixed a build problem with older (2.x) versions of gcc.
 
-  INTERNAL:
+    - Added some isType() functions that make dealing with signed characters
+      easier without forcing variables via casts.
 
-    - We now use sigaction() and sigprocmask() if possible, and fall back on
-      signal() if not.  Using sigprocmask() ensures that rsync enables all the
-      signals that it needs, just in case it was started in a masked state.
+    - Changed strcat/strcpy/sprintf function calls to use safer versions.
 
-    - Some buffer sizes were expanded a bit, particularly on systems where
-      MAXPATHLEN is overly small (e.g. cygwin).
+    - Upgraded the included popt version to 1.10.2 and improved its use of
+      string-handling functions.
 
-    - If io_printf() tries to format more data than fits in the buffer, exit
-      with an error instead of transmitting a truncated buffer.
+    - Added missing prototypes for compatibility functions from the lib dir.
 
-    - If a va_copy macro is defined, lib/snprintf.c will use it when defining
-      the VA_COPY macro.
+    - Configure determines if iconv() has a const arg, allowing us to avoid a
+      compiler warning.
 
-    - Reduced the amount of stack memory needed for each level of directory
-      recursion by nearly MAXPATHLEN bytes.
+    - Made the sending of some numbers more efficient for protocol 30.
 
-    - 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.
+    - Make sure that a daemon process doesn't mind if the client was weird and
+      omitted the --server option.
 
-    - 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.
+    - Improved the use of "const" on pointers.
 
-    - Unified the f_name() and the f_name_to() functions.
+    - Improved J.W.'s pool_alloc routines to add a way of freeing older
+      sections of a pool's memory.
 
   DEVELOPER RELATED:
 
-    - The diffs in the patches dir now require "patch -p1 <DIFF" instead of
-      the previous -p0.  Also, the version included in the release tar now
-      affect generated files (e.g. configure, rsync.1, proto.h, etc.), so
-      it is no longer necessary to run autoconf and/or yodl unless you're
-      applying a patch that was checked out from CVS.
-
-    - 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.
+    - Rsync is now licensed under the GPLv3 or later.
 
-    - There is a new script, "prepare-source" than can be used to update the
-      various generated files (proto.h, configure, etc.) even before configure
-      has created the Makefile (this is mainly useful when patching the source
-      with a patch that doesn't affect generated files).
+    - When running the tests, we now put our per-test temp dirs into a sub-
+      directory named testtmp (which is created, if missing).  This allows
+      someone to symlink the testtmp directory to another filesystem (which is
+      useful if the build dir's filesystem does not support ACLs and xattrs,
+      and another file system does).
 
-    - The testsuite now sets HOME so that it won't be affected by a file such
-      as ~/.popt.
+    - Rsync now has a way of handling protocol-version changes during the
+      development of a new protocol version.  This exchange of sub-version
+      info does not interfere with the {MIN,MAX}_PROTOCOL_VERSION checking
+      in older versions (since we'd quickly exceed the MAX_PROTOCOL_VERSION
+      if we incremented the main PROTOCOL_VERSION value for every minor
+      change during development).