Mention latest changes.
[rsync.git] / NEWS
blob135932ffa2da0b66183ca291a28dacd193563bcf
1 NEWS for rsync 3.0.0 (UNRELEASED)
2 Protocol: 30 (changed)
3 Changes since 2.6.9:
5   NOTABLE CHANGES IN BEHAVIOR:
7     - The handling of implied directories when using --relative has changed to
8       send them as directories (e.g. no implied dir is ever sent as a symlink).
9       This avoids unexpected behavior and should not adversely affect most
10       people.  If you're one of those rare individuals who relied upon having
11       an implied dir be duplicated as a symlink, you should specify the
12       transfer of the symlink and the transfer of the referent directory as
13       separate args.  (See also --keep-dirlinks and --no-implied-dirs.)
15     - Requesting a remote file list without specifying -r (--recursive) now
16       sends the -d (--dirs) option to the remote rsync rather than sending -r
17       along with an extra exclude of /*/*.  If the remote rsync does not
18       understand the -d option (i.e. it is 2.6.3 or older), you will need to
19       either turn off -d (--no-d), or specify  -r --exclude='/*/*'  manually.
21   BUG FIXES:
23     - Fixed the output of -ii when combined with one of the --*-dest options:
24       it now itemizes all the items, not just the changed ones.
26     - Made the output of all file types consistent when using a --*-dest
27       option.  Prior versions would output too many creation events for
28       matching items.
30     - The code that waits for a child pid now handles being interrupted by a
31       signal.  This fixes a problem with the pre-xfer exec function not being
32       able to get the exit status from the script.
34     - A negated filter rule (i.e. with a '!' modifier) no longer loses the
35       negation when sending the filter rules to the remote rsync.
37     - Fixed a problem with the --out-format (aka --log-format) option %f:  it
38       no longer outputs superfluous directory info for a non-daemon rsync.
40     - Fixed a problem with -vv (double --verbose) and --stats when "pushing"
41       files (which includes local copies).  Version 2.6.9 would complete the
42       copy, but exit with an error when the receiver output its memory stats.
44     - If --password-file is used on a non-daemon transfer, rsync now complains
45       and exits.  This should help users figure out that they can't use this
46       option to control a remote shell's password prompt.
48     - Make sure that directory permissions of a newly-created destination
49       directory are handled right when --perms is left off.
51     - The itemized output of a newly-created destination directory is now
52       output as a creation event, not a change event.
54     - Improved --hard-link so that more corner cases are handled correctly
55       when combined with options such as --link-dest and/or --ignore-existing.
57     - The --append option no longer updates a file that has the same size.
59     - Fixed a bug when combining --backup and --backup-dir with --inplace:
60       any missing backup directories are now created.
62     - Fixed a bug when using --backup and --inplace with --whole-file or
63       --read-batch: backup files are actually created now.
65     - Starting up an extra copy of an rsync daemon will not clobber the pidfile
66       for the running daemon -- if the pidfile exists, the new daemon will exit
67       with an error.
69     - The daemon pidfile is checked and created sooner in the startup sequence.
71     - If a daemon module's "path" value is not an absolute pathname, the code
72       now makes it absolute internally (making it work properly).
74     - Ensure that a temporary file always has owner-write permission while we
75       are writing to it.  This avoids problems with some network filesystems.
77     - Any errors output about password-file reading no longer cause an error at
78       the end of the run about a partial transfer.
80   ENHANCEMENTS:
82     - A new incremental-recursion algorithm is now used when rsync is talking
83       to another 3.x version.  This starts the transfer going more quickly
84       (before all the files have been found), and requires much less memory.
85       See the --recursive option in the manpage for some restrictions.
87     - Lowered memory use in the non-incremental-recursion algorithm for typical
88       option values (usually saving from 21-29 bytes per file).
90     - The default --delete algorithm is now --delete-during when talking to a
91       3.x rsync.  This is a faster scan than using --delete-before (which is
92       the default when talking to older rsync versions), and is compatible with
93       the new incremental recursion mode.
95     - Rsync now allows multiple remote-source args to be specified rather than
96       having to rely on a special space-splitting side-effect of the remote-
97       shell.  Additional remote args must specify the same host or an empty one
98       (e.g. empty:  :file1  or  ::module/file2).  This means that local use of
99       brace expansion now works:  rsync -av host:dir/{f1,f2} .
101     - Added the --protect-args (-s) option, that tells rsync to send most of
102       the command-line args at the start of the transfer rather than as args
103       to the remote-shell command.  This protects them from space-splitting,
104       and only interprets basic wildcard special shell characters (*?[).
106     - Added the --delete-delay option, which is a more efficient way to delete
107       files at the end of the transfer without needing a separate delete pass.
109     - Added the --acls (-A) option to preserve Access Control Lists.  This is
110       an improved version of the prior patch that was available, and it even
111       supports OS X ACLs.  If you need to have backward compatibility with old,
112       acl-patched versions of rsync, apply the acls.diff file from the patches
113       dir.
115     - Added the --xattrs (-X) option to preserver extended attributes.  This is
116       an improved version of the prior patch that was available, and it even
117       supports OS X xattrs (which includes their resource fork data).  If you
118       need to have backward compatibility with old, xattr-patched versions of
119       rsync, apply the xattrs.diff file from the patches dir.
121     - Added the --fake-super option that allows a non-super user to preserve
122       all attributes of a file by using a special extended-attribute idiom.
123       It even supports the storing of foreign ACL data on your backup server.
124       There is also an analogous "fake super" option for an rsync daemon.
126     - Added the --iconv option, which allows rsync to convert filenames from
127       one character-set to another during the transfer.  The default is to make
128       this feature available as long as your system has iconv_open().  If
129       compilation fails, specify --disable-iconv to configure, and then
130       rebuild.  If you want rsync to perform character-set conversions by
131       default, you can specify --enable-iconv=CONVERT_STRING with the default
132       value for the --iconv option that you wish to use.  For example,
133       "--enable-iconv=." is a good choice.  See the rsync manpage for an
134       explanation of the --iconv option's settings.
136     - Added the --skip-compress=LIST option to override the default list of
137       file suffixes that will not be compressed when using --compress.
138       
139     - The daemon's default for "dont compress" was extended to include:
140           *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
141       The matching routine was also optimized to run more quickly.
143     - The --max-delete option now outputs a warning if it skipped any file
144       deletions, including a count of how many deletions were skipped.  (Older
145       versions just silently stopped deleting things.)
147     - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
148       about extraneous files without deleting anything.  If you're not sure
149       what version the client is, you can use the less-obvious --max-delete=-1,
150       as both old and new versions will treat that as the same request (though
151       older versions don't warn).
153     - The --hard-link option now uses less memory on both the sending and
154       receiving side for all protocol versions.  For protocol 30, the use of a
155       hashtable on the sending side allows us to more efficiently convey to the
156       receiver what files are linked together.  This reduces the amount of data
157       sent over the socket by a considerable margin (rather than adding more
158       data), and limits the in-memory storage of the device+inode information
159       to just the sending side for the new protocol 30, or to the receiving
160       side when speaking an older protocol (note that older rsync versions kept
161       the device+inode information on both sides).
163     - The filter rules now support a perishable ("p") modifier that marks rules
164       that should not have an effect in a directory that is being deleted.  e.g.
165       -f '-p .svn/' would only affect "live" .svn directories.
167     - If we get an error setting the time on a symlink, we don't complain about
168       it anymore (since some operating systems don't support that, and it's not
169       that important).
171     - Protocol 30 now uses MD5 checksums instead of MD4.
173     - Changed the --append option to not checksum the existing data in the
174       destination file, which speeds up file appending.
176     - Added the --append-verify option, which works like the older --append
177       option (verifying the existing data in the destination file).  For
178       compatibility with older rsync versions, any use of --append that is
179       talking protocol 29 or older will revert to the --append-verify method.
181     - Documented and extended the support for the RSYNC_CONNECT_PROG variable
182       that can be used to enhance the client side of a daemon connection.
184     - Improved the dashes and double-quotes in the nroff manpage output.
186     - We now support a lot more --no-OPTION override options.
188   INTERNAL:
190     - The file-list sorting algorithm now uses a sort that keeps any same-
191       named items in the same order as they were specified.  This allows
192       rsync to always ensure that the first of the duplicates is the one
193       that will be included in the copy.  The new sort was also faster
194       than the glibc version of qsort() and mergesort() in my testing.
196     - Rsync now supports the transfer of 64-bit timestamps (time_t values).
198     - Fixed a build problem with older (2.x) versions of gcc.
200     - Added some isType() functions that make dealing with signed characters
201       easier without forcing variables via casts.
203     - Changed strcat/strcpy/sprintf function calls to use safer versions.
205     - Upgraded the included popt version to 1.10.2 and improved its use of
206       string-handling functions.
208     - Added missing prototypes for compatibility functions from the lib dir.
210     - Configure determines if iconv() has a const arg, allowing us to avoid a
211       compiler warning.
213     - Made the sending of some numbers more efficient for protocol 30.
215     - Make sure that a daemon process doesn't mind if the client was weird and
216       omitted the --server option.
218     - Improved the use of "const" on pointers.
220     - Improved J.W.'s pool_alloc routines to add a way of freeing older
221       sections of a pool's memory.
223     - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
224       some new code (derived from samba, derived from PostgreSQL) that has a
225       better license than the old code.
227   DEVELOPER RELATED:
229     - Rsync is now licensed under the GPLv3 or later.
231     - When running the tests, we now put our per-test temp dirs into a sub-
232       directory named testtmp (which is created, if missing).  This allows
233       someone to symlink the testtmp directory to another filesystem (which is
234       useful if the build dir's filesystem does not support ACLs and xattrs,
235       but another file system does).
237     - Rsync now has a way of handling protocol-version changes during the
238       development of a new protocol version.  This causes any out-of-sync
239       versions to speak an older protocol rather than fail in a cryptic manner.
240       This addition makes it safe to deploy a pre-release version that may
241       interact with the public.  This new exchange of sub-version info does not
242       interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
243       does not have enough range to allow the main protocol number to be
244       incremented for every minor tweak in that happens during development).