More improvements and a couple missing items.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 8d3ea67..6bf3e4e 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -2,11 +2,29 @@ NEWS for rsync 2.6.3 (UNRELEASED)
 Protocol: 28 (unchanged)
 Changes since 2.6.2:
 
+  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).
+
   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).
 
@@ -14,18 +32,18 @@ Changes since 2.6.2:
       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 file has a read error on the sending side, the receiver will
-      no longer keep the resulting file unless the --partial option was
-      specified.  (Note:  both sides must be running 2.6.3 for this to
-      work -- older receivers always keep the file, and older senders
-      don't tell the receiver that the file was not read correctly.)
+    - 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 (losing the
-      original file in the process).
-
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
+      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
@@ -41,6 +59,10 @@ Changes since 2.6.2:
       for a symlink that has no referent instead of claiming that a file
       "vanished".
 
+    - 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.
+
     - 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
@@ -60,13 +82,47 @@ Changes since 2.6.2:
       suggest that the user specify --ipv4 or --ipv6 (if we think it will
       help).
 
+    - 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).
+
+    - 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).
+
+    - 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.
+
+    - Fixed an age-old crash problem with --read-batch on a local copy
+      (rsync was improperly assuming --whole-file for the local copy).
+
+    - 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.
+
   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
+
     - 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 "write only" option to the daemon's config file.
+    - 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.
@@ -80,19 +136,60 @@ Changes since 2.6.2:
 
     - 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 via
+      stdin over 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.
+
+    - The finished file now gets its permissions and modified-time updated
+      before it gets moved into place.
+
+    - Lots of documentation improvements in the exclude/include sections.
+
   INTERNAL:
 
     - Some cleanup in the exclude code has saved some per-exclude memory
       and made the code easier to maintain.
 
-    - Use rsyserr() in the various places that were still calling
-      rprintf() with strerror() as an arg.
+    - 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.
 
     - 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).
 
+    - Optimized the handling of larger block sizes (rsync used to slow to a
+      crawl if the block size got too large).
+
+    - Optimized away a loop in hash_search().
+
+    - 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).
+
+    - 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.
+
   BUILD CHANGES:
 
     - Added a "gen" target to rebuild most of the generated files,
@@ -106,9 +203,12 @@ Changes since 2.6.2:
       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.
+    - 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.