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