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