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