3aeebb99176e6c01d70b7d25de978fa4084d24a5
[rsync.git] / NEWS
1 NEWS for rsync 3.0.0 (UNRELEASED)
2 Protocol: 30 (changed)
3 Changes since 2.6.9:
4
5   NOTABLE CHANGES IN BEHAVIOR:
6
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.)
14       Also, exclude rules no longer have a partial effect on implied dirs.
15
16     - Requesting a remote file list without specifying -r (--recursive) now
17       sends the -d (--dirs) option to the remote rsync rather than sending -r
18       along with an extra exclude of /*/*.  If the remote rsync does not
19       understand the -d option (i.e. it is 2.6.3 or older), you will need to
20       either turn off -d (--no-d), or specify  -r --exclude='/*/*'  manually.
21
22     - In --dry-run mode, the last line of the verbose summary text is output
23       with a "(DRY RUN)" suffix to help remind you that no updates were made.
24       Similarly, --only-write-batch outputs "(BATCH ONLY)".
25
26     - A writable rsync daemon with "use chroot" disabled now defaults to a
27       symlink-munging behavior designed to make symlinks safer while also
28       allowing absolute symlinks to be stored and retrieved.  This also has
29       the effect of making symlinks unusable while they're in the daemon's
30       hierarchy.  See the daemon option "munge symlinks" for full details.
31
32   BUG FIXES:
33
34     - A daemon with "use chroot = no" and excluded items listed in the daemon
35       config file now properly checks an absolute-path arg specified for these
36       options:  --compare-dest, --link-dest, --copy-dest, --partial-dir,
37       --backup-dir, --temp-dir, and --files-from.
38
39     - If a file's data arrived successfully on the receiving side but the
40       rename of the temporary file to the destination file failed AND the
41       --remove-source-files (or the deprecated --remove-sent-files) option
42       was specified, rsync no longer erroneously removes the associated
43       source file.
44
45     - Fixed the output of -ii when combined with one of the --*-dest options:
46       it now itemizes all the items, not just the changed ones.
47
48     - Made the output of all file types consistent when using a --*-dest
49       option.  Prior versions would output too many creation events for
50       matching items.
51
52     - The code that waits for a child pid now handles being interrupted by a
53       signal.  This fixes a problem with the pre-xfer exec function not being
54       able to get the exit status from the script.
55
56     - A negated filter rule (i.e. with a '!' modifier) no longer loses the
57       negation when sending the filter rules to the remote rsync.
58
59     - Fixed a problem with the --out-format (aka --log-format) option %f:  it
60       no longer outputs superfluous directory info for a non-daemon rsync.
61
62     - Fixed a problem with -vv (double --verbose) and --stats when "pushing"
63       files (which includes local copies).  Version 2.6.9 would complete the
64       copy, but exit with an error when the receiver output its memory stats.
65
66     - If --password-file is used on a non-daemon transfer, rsync now complains
67       and exits.  This should help users figure out that they can't use this
68       option to control a remote shell's password prompt.
69
70     - Make sure that directory permissions of a newly-created destination
71       directory are handled right when --perms is left off.
72
73     - The itemized output of a newly-created destination directory is now
74       output as a creation event, not a change event.
75
76     - Improved --hard-link so that more corner cases are handled correctly
77       when combined with options such as --link-dest and/or --ignore-existing.
78
79     - The --append option no longer updates a file that has the same size.
80
81     - Fixed a bug when combining --backup and --backup-dir with --inplace:
82       any missing backup directories are now created.
83
84     - Fixed a bug when using --backup and --inplace with --whole-file or
85       --read-batch: backup files are actually created now.
86
87     - Starting up an extra copy of an rsync daemon will not clobber the pidfile
88       for the running daemon -- if the pidfile exists, the new daemon will exit
89       with an error.
90
91     - The daemon pidfile is checked and created sooner in the startup sequence.
92
93     - If a daemon module's "path" value is not an absolute pathname, the code
94       now makes it absolute internally (making it work properly).
95
96     - Ensure that a temporary file always has owner-write permission while we
97       are writing to it.  This avoids problems with some network filesystems.
98
99     - Any errors output about password-file reading no longer cause an error at
100       the end of the run about a partial transfer.
101
102     - The --read-batch option for protocol 30 now ensures that several more
103       options are set correctly for the current batch file:  --iconv, --acls,
104       --xattrs, --inplace, --append, and --append-verify.
105
106     - Using --only-write-batch to a daemon receiver now work properly (older
107       versions would update some files while writing the batch).
108
109     - Avoid outputing a "file has vanished" message when the file is a broken
110       symlink and --copy-unsafe-links or --copy-dirlinks are used (the code
111       already handled this for --copy-links).
112
113     - Fixed the combination of --only-write-batch and --dry-run.
114
115   ENHANCEMENTS:
116
117     - A new incremental-recursion algorithm is now used when rsync is talking
118       to another 3.x version.  This starts the transfer going more quickly
119       (before all the files have been found), and requires much less memory.
120       See the --recursive option in the manpage for some restrictions.
121
122     - Lowered memory use in the non-incremental-recursion algorithm for typical
123       option values (usually saving from 21-29 bytes per file).
124
125     - The default --delete algorithm is now --delete-during when talking to a
126       3.x rsync.  This is a faster scan than using --delete-before (which is
127       the default when talking to older rsync versions), and is compatible with
128       the new incremental recursion mode.
129
130     - Rsync now allows multiple remote-source args to be specified rather than
131       having to rely on a special space-splitting side-effect of the remote-
132       shell.  Additional remote args must specify the same host or an empty one
133       (e.g. empty:  :file1  or  ::module/file2).  This means that local use of
134       brace expansion now works:  rsync -av host:dir/{f1,f2} .
135
136     - Added the --protect-args (-s) option, that tells rsync to send most of
137       the command-line args at the start of the transfer rather than as args
138       to the remote-shell command.  This protects them from space-splitting,
139       and only interprets basic wildcard special shell characters (*?[).
140
141     - Added the --delete-delay option, which is a more efficient way to delete
142       files at the end of the transfer without needing a separate delete pass.
143
144     - Added the --acls (-A) option to preserve Access Control Lists.  This is
145       an improved version of the prior patch that was available, and it even
146       supports OS X ACLs.  If you need to have backward compatibility with old,
147       ACL-patched versions of rsync, apply the acls.diff file from the patches
148       dir.
149
150     - Added the --xattrs (-X) option to preserver extended attributes.  This is
151       an improved version of the prior patch that was available, and it even
152       supports OS X xattrs (which includes their resource fork data).  If you
153       need to have backward compatibility with old, xattr-patched versions of
154       rsync, apply the xattrs.diff file from the patches dir.
155
156     - Added the --fake-super option that allows a non-super user to preserve
157       all attributes of a file by using a special extended-attribute idiom.
158       It even supports the storing of foreign ACL data on your backup server.
159       There is also an analogous "fake super" option for an rsync daemon.
160
161     - Added the --iconv option, which allows rsync to convert filenames from
162       one character-set to another during the transfer.  The default is to make
163       this feature available as long as your system has iconv_open().  If
164       compilation fails, specify --disable-iconv to configure, and then
165       rebuild.  If you want rsync to perform character-set conversions by
166       default, you can specify --enable-iconv=CONVERT_STRING with the default
167       value for the --iconv option that you wish to use.  For example,
168       "--enable-iconv=." is a good choice.  See the rsync manpage for an
169       explanation of the --iconv option's settings.
170
171     - Added the --skip-compress=LIST option to override the default list of
172       file suffixes that will not be compressed when using --compress.
173
174     - The daemon's default for "dont compress" was extended to include:
175           *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg
176       The matching routine was also optimized to run more quickly.
177
178     - The --max-delete option now outputs a warning if it skipped any file
179       deletions, including a count of how many deletions were skipped.  (Older
180       versions just silently stopped deleting things.)
181
182     - You may specify --max-delete=0 to a 3.0.0 client to request that it warn
183       about extraneous files without deleting anything.  If you're not sure
184       what version the client is, you can use the less-obvious --max-delete=-1,
185       as both old and new versions will treat that as the same request (though
186       older versions don't warn).
187
188     - The --hard-link option now uses less memory on both the sending and
189       receiving side for all protocol versions.  For protocol 30, the use of a
190       hashtable on the sending side allows us to more efficiently convey to the
191       receiver what files are linked together.  This reduces the amount of data
192       sent over the socket by a considerable margin (rather than adding more
193       data), and limits the in-memory storage of the device+inode information
194       to just the sending side for the new protocol 30, or to the receiving
195       side when speaking an older protocol (note that older rsync versions kept
196       the device+inode information on both sides).
197
198     - The filter rules now support a perishable ("p") modifier that marks rules
199       that should not have an effect in a directory that is being deleted.  e.g.
200       -f '-p .svn/' would only affect "live" .svn directories.
201
202     - Rsync checks all the alternate-destination args for validity (e.g.
203       --link-dest).  This lets the user know when they specified a directory
204       that does not exist.
205
206     - If we get an error setting the time on a symlink, we don't complain about
207       it anymore (since some operating systems don't support that, and it's not
208       that important).
209
210     - Protocol 30 now uses MD5 checksums instead of MD4.
211
212     - Changed the --append option to not checksum the existing data in the
213       destination file, which speeds up file appending.
214
215     - Added the --append-verify option, which works like the older --append
216       option (verifying the existing data in the destination file).  For
217       compatibility with older rsync versions, any use of --append that is
218       talking protocol 29 or older will revert to the --append-verify method.
219
220     - Added the --contimeout=SECONDS option that lets the user specify a
221       connection timeout for rsync daemon access.
222
223     - Documented and extended the support for the RSYNC_CONNECT_PROG variable
224       that can be used to enhance the client side of a daemon connection.
225
226     - Improved the dashes and double-quotes in the nroff manpage output.
227
228     - We now support a lot more --no-OPTION override options.
229
230   INTERNAL:
231
232     - The file-list sorting algorithm now uses a sort that keeps any same-
233       named items in the same order as they were specified.  This allows
234       rsync to always ensure that the first of the duplicates is the one
235       that will be included in the copy.  The new sort was also faster
236       than the glibc version of qsort() and mergesort() in my testing.
237
238     - Rsync now supports the transfer of 64-bit timestamps (time_t values).
239
240     - Made the file-deletion code use a little less stack when recursing
241       through a directory hierarchy of extraneous files.
242
243     - Fixed a build problem with older (2.x) versions of gcc.
244
245     - Added some isType() functions that make dealing with signed characters
246       easier without forcing variables via casts.
247
248     - Changed strcat/strcpy/sprintf function calls to use safer versions.
249
250     - Upgraded the included popt version to 1.10.2 and improved its use of
251       string-handling functions.
252
253     - Added missing prototypes for compatibility functions from the lib dir.
254
255     - Configure determines if iconv() has a const arg, allowing us to avoid a
256       compiler warning.
257
258     - Made the sending of some numbers more efficient for protocol 30.
259
260     - Make sure that a daemon process doesn't mind if the client was weird and
261       omitted the --server option.
262
263     - There are more internal logging categories available in protocol 30 than
264       the age-old FINFO and FERROR, including FERROR_XFER and FWARN.  These new
265       categories allow some errors and warnings to go to stderr without causing
266       an erroneous end-of-run warning about some files not being able to be
267       transferred.
268
269     - Improved the use of "const" on pointers.
270
271     - Improved J.W.'s pool_alloc routines to add a way of freeing older
272       sections of a pool's memory.
273
274     - The getaddrinfo.c compatibility code in the "lib" dir was replaced with
275       some new code (derived from samba, derived from PostgreSQL) that has a
276       better license than the old code.
277
278   DEVELOPER RELATED:
279
280     - Rsync is now licensed under the GPLv3 or later.
281
282     - Rsync is now being maintained in a "git" repository instead of CVS
283       (though the old CVS repository still exists).  Several maintenance
284       scripts were updated to work with git.
285
286     - Generated files are no longer committed into the source repository.  The
287       autoconf and autoheader commands are now automatically run during the
288       normal use of "configure" and "make".  The latest dev versions of all
289       generated files can also be copied from the samba.org web site (see the
290       "magic" configure script that now comes with rsync for its location).
291
292     - The "patches" directory of diff files is now built from branches in the
293       rsync git repository (branch patch/FOO creates file patches/FOO.diff).
294
295     - The proto.h file is now built using a simple perl script rather than a
296       complex awk script, which proved to be more widely compatible.
297
298     - When running the tests, we now put our per-test temp dirs into a sub-
299       directory named testtmp (which is created, if missing).  This allows
300       someone to symlink the testtmp directory to another filesystem (which is
301       useful if the build dir's filesystem does not support ACLs and xattrs,
302       but another file system does).
303
304     - Rsync now has a way of handling protocol-version changes during the
305       development of a new protocol version.  This causes any out-of-sync
306       versions to speak an older protocol rather than fail in a cryptic manner.
307       This addition makes it safe to deploy a pre-release version that may
308       interact with the public.  This new exchange of sub-version info does not
309       interfere with the {MIN,MAX}_PROTOCOL_VERSION checking algorithm (which
310       does not have enough range to allow the main protocol number to be
311       incremented for every minor tweak in that happens during development).
312
313     - The csprotocol.txt file was updated to mention the daemon protocol change
314       in the 3.0.0 release.