Adding a support script that can be used to make the checked-out
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index a4e7a1d..e8b87a3 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.1 (UNRELEASED)
-Protocol: 27 (unchanged)
-Changes since 2.6.0:
+NEWS for rsync 3.0.0 (UNRELEASED)
+Protocol: 30 (changed)
+Changes since 2.6.9:
 
-  ENHANCEMENTS:
+  NOTABLE CHANGES IN BEHAVIOR:
 
-    * Lower memory use and more optimal transfer of data over
-      the socket (see the INTERNAL section for details).
+    - 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 individuals who relied upon having
+      an implied dir be duplicated as a symlink, you should specify the
+      transfer of the symlink and the transfer of the referent directory as
+      separate args.  (See also --keep-dirlinks and --no-implied-dirs.)
 
-    * The RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
+    - Requesting a remote file list without specifying -r (--recursive) now
+      sends the -d (--dirs) option to the remote rsync rather than sending -r
+      along with an extra exclude of /*/*.  If the remote rsync does not
+      understand the -d option (i.e. it is 2.6.3 or older), you will need to
+      either turn off -d (--no-d), or specify  -r --exclude='/*/*'  manually.
 
-    * The --progress output now mentions how far along in the
-      transfer we are, including both a count of files transferred
-      and a percentage of the total file-count that we're processed.
+    - In --dry-run mode, the last line of the verbose summary text is output
+      with a "(DRY RUN)" suffix to help remind you that no updates were made.
 
   BUG FIXES:
 
-    * The --link-dest code now works properly for a non-root user
-      when the UIDs of the source and destination differ and -u was
-      specified, and when the group of the source can't be used on
-      the destination and -g was specified.  (Wayne Davison)
-
-    * Fixed a bug in the handling of -H (hard-links) that might
-      cause the expanded PATH/NAME value of the current item to
-      get overwritten (due to an expanded-name caching bug).
-      (Wayne Davison)
-      
-    * Keep per-file track of the sending of literal data with
-      --partial so that an interrupted transfer doesn't keep a
-      shorter temp file when no new data has been transfered over
-      the wire.  (Wayne Davison)
+    - Fixed the output of -ii when combined with one of the --*-dest options:
+      it now itemizes all the items, not just the changed ones.
 
-    * Fixed a byte-order problem in --batch-mode on big-endian
-      machines.  (Jay Fenlason)
+    - Made the output of all file types consistent when using a --*-dest
+      option.  Prior versions would output too many creation events for
+      matching items.
 
-    * Fixed configure bug when running "./configure --disable-ipv6".
-      (Wayne Davison)
+    - 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.
 
-    * Fixed "make test" bug when build dir is not the source dir.
+    - A negated filter rule (i.e. with a '!' modifier) no longer loses the
+      negation when sending the filter rules to the remote rsync.
 
-    * When using --cvs-exclude, the exclude items we get from a
-      directory's .cvsignore file once again only affect that one
-      directory (and not all following directories too).
+    - Fixed a problem with the --out-format (aka --log-format) option %f:  it
+      no longer outputs superfluous directory info for a non-daemon rsync.
 
-    * When transferring a file that has group 0 with -g specified
-      (typically via -a) and not enough privs to retain the group,
-      rsync no longer complains about chown failing.
+    - 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.
 
-    * When specifying the USER@HOST: prefix for a file, the USER
-      part can now contain an '@', if needed (i.e. the last '@'
-      is used to find the HOST, not the first).
-
-  INTERNAL:
+    - 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.
 
-    * Most of the I/O is now buffered, which results in a pretty
-      large speedup when running under MS Windows.  (Craig Barratt)
+    - Make sure that directory permissions of a newly-created destination
+      directory are handled right when --perms is left off.
 
-    * Optimizations to the name-handling/comparing code have made
-      some significant reductions in user-CPU time for large file
-      sets.  (Wayne Davison)
+    - The itemized output of a newly-created destination directory is now
+      output as a creation event, not a change event.
 
-    * Some variable-type cleanup that makes the code more consistent.
-      (Wayne Davison)
+    - Improved --hard-link so that more corner cases are handled correctly
+      when combined with options such as --link-dest and/or --ignore-existing.
 
-    * Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - The --append option no longer updates a file that has the same size.
 
-    * Implemented a new algorithm for hard-link handling that speeds
-      up the code significantly.  (J.W. Schultz and Wayne Davison)
+    - Fixed a bug when combining --backup and --backup-dir with --inplace:
+      any missing backup directories are now created.
 
-    * Got rid of support for protocol versions 17 and 18 (which are
-      both over 6 years old).  (Wayne Davison)
+    - Fixed a bug when using --backup and --inplace with --whole-file or
+      --read-batch: backup files are actually created now.
 
-    * More optimal data transmission for --hard-links (protocol 28).
+    - Starting up an extra copy of an rsync daemon will not clobber the pidfile
+      for the running daemon -- if the pidfile exists, the new daemon will exit
+      with an error.
 
-    * More optimal data transmission for --checksum (protocol 28).
+    - The daemon pidfile is checked and created sooner in the startup sequence.
 
-    * Less memory used for holding --checksum data.
+    - If a daemon module's "path" value is not an absolute pathname, the code
+      now makes it absolute internally (making it work properly).
 
-    * Less memory used per-file in the file list.
+    - Ensure that a temporary file always has owner-write permission while we
+      are writing to it.  This avoids problems with some network filesystems.
 
-    * The 2 pipes used between the receiver and generator processes
-      (which are forked on the same machine) were reduced to 1 pipe
-      and the protocol improved so that (1) it is now impossible to
-      have the "redo" pipe fill up and hang rsync, and (2) trailing
-      messages from the receiver don't get lost on their way through
-      the generator over to the sender (the latter mainly affected
-      hard-link messages).  (Wayne Davison)
-
-    * The reading & writing of the file list in batch-mode is now
-      handled by the same code that sends & receives the list over
-      the wire.  This makes it much easier to maintain.
-
-\f
-NEWS for rsync 2.6.0 (1 Jan 2004)
-Protocol: 27 (changed)
-Changes since 2.5.7:
+    - Any errors output about password-file reading no longer cause an error at
+      the end of the run about a partial transfer.
 
   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 version
-      27. (J.W. Schultz)
-
-    * Per-file dynamic block size is now sqrt(file length).  The
-      per-file checksum size is determined according to an algorithm
-      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.
-
-    * Various trailing-info sections are now preceded by a newline.
-
-  BUG FIXES:
+    - 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.
+
+    - Lowered memory use 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 an empty one
+      (e.g. empty:  :file1  or  ::module/file2).  This means that local use of
+      brace expansion now works:  rsync -av host:dir/{f1,f2} .
+
+    - 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 (*?[).
+
+    - 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,
+      acl-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, and it even
+      supports OS X xattrs (which includes their resource fork data).  If you
+      need to have backward compatibility with old, xattr-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.
+      It even supports the storing of foreign ACL data on your backup server.
+      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 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.
 
-    * 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)
+    - 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.)
 
-      - A pattern with a "**" no longer causes a "*" to match slashes.
-        For example, with "/*/foo/**", "foo" must be 2 levels deep.
-       [If your string has BOTH "*" and "**" wildcards, changing the
-       "*" wildcards to "**" will provide the old behavior in all
-       versions.]
+    - 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).
 
-      - "**/foo" now matches at the base of the transfer (like /foo
-        does).  [Use "/**/foo" to get the old behavior in all versions.]
+    - 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).
 
-      - A 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. [Use "/CVS/R*"
-        to get the old behavior in all versions.]
+    - 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.
 
-      - 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" (unlike before).  [Use "foo*bar" to get the
-        old behavior in all versions.]
+    - 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).
 
-    * 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)
+    - Protocol 30 now uses MD5 checksums instead of MD4.
 
-    * 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)
+    - Changed the --append option to not checksum the existing data in the
+      destination file, which speeds up file appending.
 
-    * 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)
+    - 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.
 
-    * 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)
+    - Documented and extended the support for the RSYNC_CONNECT_PROG variable
+      that can be used to enhance the client side of a daemon connection.
 
-    * Keep tmp names from overflowing MAXPATHLEN.
+    - Improved the dashes and double-quotes in the nroff manpage output.
 
-    * Make --link-dest honor the absence of -p, -o, and -g.
+    - We now support a lot more --no-OPTION override options.
 
-    * Made rsync treat a trailing slash in the destination in a more
-      consistent manner.
+  INTERNAL:
 
-    * Fixed file I/O error detection.  (John Van Essen)
+    - 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.
 
-    * 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.
+    - Rsync now supports the transfer of 64-bit timestamps (time_t values).
 
-    * Print heap statistics when verbose >= 2 instead of when >= 1.
+    - Fixed a build problem with older (2.x) versions of gcc.
 
-    * Fixed a compression (-z) bug when syncing a mostly-matching file
-      that contains already-compressed data.  (Yasuoka Masahiko and
-      Wayne Davison)
+    - Added some isType() functions that make dealing with signed characters
+      easier without forcing variables via casts.
 
-    * Fixed a bug in the --backup code that could cause deleted files
-      to not get backed up.
+    - Changed strcat/strcpy/sprintf function calls to use safer versions.
 
-    * When the backup code makes new directories, create them with mode
-      0700 instead of 0755 (since the directory permissions in the
-      backup tree are not yet copied from the main tree).
+    - Upgraded the included popt version to 1.10.2 and improved its use of
+      string-handling functions.
 
-    * Call setgroups() in a more portable manner.
+    - Added missing prototypes for compatibility functions from the lib dir.
 
-    * Improved file-related error messages to better indicate exactly
-      what pathname failed. (Wayne Davison)
+    - Configure determines if iconv() has a const arg, allowing us to avoid a
+      compiler warning.
 
-    * Fixed some bugs in the handling of --delete and --exclude when
-      using the --relative (-R) option. (Wayne Davison)
+    - Made the sending of some numbers more efficient for protocol 30.
 
-    * 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)
+    - Make sure that a daemon process doesn't mind if the client was weird and
+      omitted the --server option.
 
-    * Detect and report when open or opendir succeed but read and
-      readdir fail caused by network filesystem issues and truncated
-      files.  (David Norwood, Michael Brown, J.W. Schultz)
+    - Improved the use of "const" on pointers.
 
-    * Added a fix that should give ssh time to restore the tty settings
-      if the user presses Ctrl-C at an ssh password prompt.
+    - Improved J.W.'s pool_alloc routines to add a way of freeing older
+      sections of a pool's memory.
 
-  INTERNAL:
+    - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
+      some new code (derived from samba, derived from PostgreSQL) that has a
+      better license than the old code.
 
-    * Eliminated vestigial support for old versions that we stopped
-      supporting. (J.W. Schultz)
+  DEVELOPER RELATED:
 
-    * Simplified some of the option-parsing code. (Wayne Davison)
+    - Rsync is now licensed under the GPLv3 or later.
 
-    * Some cleanup made to the exclude code, as well as some new
-      defines added to enhance readability. (Wayne Davison)
+    - 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,
+      but another file system does).
 
-    * 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)
+    - Rsync now has a way of handling protocol-version changes during the
+      development of a new protocol version.  This causes any out-of-sync
+      versions to speak an older protocol rather than fail in a cryptic manner.
+      This addition makes it safe to deploy a pre-release version that may
+      interact with the public.  This new exchange of sub-version info does not
+      interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
+      does not have enough range to allow the main protocol number to be
+      incremented for every minor tweak in that happens during development).