Mention latest fix.
[rsync/rsync.git] / NEWS
1 NEWS for rsync 2.6.4 (UNRELEASED)
2 Protocol: 28 (unchanged)
3 Changes since 2.6.3:
4
5   BUG FIXES:
6
7     - Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
8       was only treating it as a special token in an rsync include/exclude
9       file).
10
11     - Avoid a mkdir warning when removing a directory in the destination
12       that already exists in the --backup-dir.
13
14     - An OS that has a binary mode for its files (such as cygwin0 needed
15       setmode(fd, O_BINARY) called on the temp-file we opened with
16       mkstemp().
17
18     - We now check if the OS doesn't support using mknod() for creating
19       FIFOs and sockets, and compile-in using mkfifo() and socket() when
20       necessary.
21
22     - Fixed an off-by-one error in the handling of --max-delete=N.
23
24   ENHANCEMENTS:
25
26     - The daemon-mode options were separated from the normal rsync options
27       so that they can't be mixed together.  This makes it impossible for a
28       user to start a daemon that had improper default option values that
29       could cause problems (a hang or an exit) when a client connects.
30
31     - In _exit_cleanup(): when we are exiting with a partially-received
32       file, we now flush any data in the write-cache before closing the
33       partial file.
34
35   BUILD CHANGES:
36
37     - Support an OS that uses mkdev() instead of makedev().
38
39 \f
40 NEWS for rsync 2.6.3 (30 Sep 2004)
41 Protocol: 28 (unchanged)
42 Changes since 2.6.2:
43
44   SECURITY FIXES:
45
46     - A bug in the sanitize_path routine (which affects a non-chrooted
47       rsync daemon) could allow a user to craft a pathname that would get
48       transformed into an absolute path for certain options (but not for
49       file-transfer names).  If you're running an rsync daemon with chroot
50       disabled, *please upgrade*, ESPECIALLY if the user privs you run
51       rsync under is anything above "nobody".
52
53   OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
54
55     - Please note that the 2-line footer (output when verbose) now uses the
56       term "sent" instead of "wrote" and "received" instead of "read".  If
57       you are not parsing the numeric values out of this footer, a script
58       would be better off using the empty line prior to the footer as the
59       indicator that the verbose output is over.
60       
61     - The output from the --stats option was similarly affected to change
62       "written" to "sent" and "read" to "received".
63
64     - Rsync ensures that a filename that contains a newline gets mentioned
65       with each newline transformed into a question mark (which prevents a
66       filename from causing an empty line to be output).
67
68     - The "backed up ..." message that is output when at least 2 --verbose
69       options are specified is now the same both with and without the
70       --backup-dir option.
71
72   BUG FIXES:
73
74     - Fixed a crash bug that might appear when --delete was used and
75       multiple source directories were specified.
76
77     - Fixed a 32-bit truncation of the file length when generating the
78       checksums.
79
80     - The --backup code no longer attempts to create some directories
81       over and over again (generating warnings along the way).
82
83     - Fixed a bug in the reading of the secrets file (by the daemon) and
84       the password file (by the client):  the files no longer need to be
85       terminated by a newline for their content to be read in.
86
87     - If a file has a read error on the sending side or the reconstructed
88       data doesn't match the expected checksum (perhaps due to the basis
89       file changing during the transfer), the receiver will no longer
90       retain the resulting file unless the --partial option was specified.
91       (Note: for the read-error detection to work, neither side can be
92       older than 2.6.3 -- older receivers will always retain the file, and
93       older senders don't tell the receiver that the file had a read
94       error.)
95
96     - If a file gets resent in a single transfer and the --backup option
97       is enabled, rsync no longer performs a duplicate backup (it used to
98       overwrite the original file in the backup area).
99
100     - Files specified in the daemon's "exclude" or "exclude from" config
101       items are now excluded from being uploaded (assuming that the module
102       allows uploading at all) in addition to the old download exclusion.
103
104     - Got rid of a potential hang in the receiver when near the end of a
105       phase.
106
107     - When using --backup without a --backup-dir, rsync no longer preserves
108       the modify time on directories.  This avoids confusing NFS.
109
110     - When --copy-links (-L) is specified, we now output a separate error
111       for a symlink that has no referent instead of claiming that a file
112       "vanished".
113
114     - The --copy-links (-L) option no longer has the side-effect of telling
115       the receiving side to follow symlinks.  See the --keep-dirlinks
116       option (mentioned below) for a way to specify that behavior.
117
118     - Error messages from the daemon server's option-parsing (such as
119       refused options) are now successfully transferred back to the client
120       (the server used to fail to send the message because the socket
121       wasn't in the right state for the message to get through).
122
123     - Most transfer errors that occur during a daemon transfer are now
124       returned to the user in addition to being logged (some messages are
125       intended to be daemon-only and are not affected by this).
126
127     - Fixed a bug in the daemon authentication code when using one of the
128       batch-processing options.
129
130     - We try to work around some buggy IPv6 implementations that fail to
131       implement IPV6_V6ONLY.  This should fix the "address in use" error
132       that some daemons get when running on an OS with a buggy IPv6
133       implementation.  Also, if the new code gets this error, we might
134       suggest that the user specify --ipv4 or --ipv6 (if we think it will
135       help).
136
137     - When the remote rsync dies, make a better effort to recover any error
138       messages it may have sent before dying (the local rsync used to just
139       die with a socket-write error).
140
141     - When using --delete and a --backup-dir that contains files that are
142       hard-linked to their destination equivalents, rsync now makes sure
143       that removed files really get removed (avoids a really weird rename()
144       behavior).
145
146     - Avoid a bogus run-time complaint about a lack of 64-bit integers when
147       the int64 type is defined as an off_t and it actually has 64-bits.
148
149     - Added a configure check for open64() without mkstemp64() so that we
150       can avoid using mkstemp() when such a combination is encountered.
151       This bypasses a problem writing out large temp files on OSes such as
152       AIX and HP-UX.
153
154     - Fixed an age-old crash problem with --read-batch on a local copy
155       (rsync was improperly assuming --whole-file for the local copy).
156
157     - When --dry-run (-n) is used and the destination directory does not
158       exist, rsync now produces a correct report of files that would be
159       sent instead of dying with a chdir() error.
160
161     - Fixed a bug that could cause a slow-to-connect rsync daemon to die
162       with an error instead of waiting for the connection to finish.
163
164     - Fixed an ssh interaction that could cause output to be lost when the
165       user chose to combine the output of rsync's stdout and stderr (e.g.
166       using the "2>&1").
167
168   ENHANCEMENTS:
169
170     - Added the --partial-dir=DIR option that lets you specify where to
171       (temporarily) put a partially transferred file (instead of over-
172       writing the destination file).  E.g.  --partial-dir=.rsync-partial
173       Also added support for the RSYNC_PARTIAL_DIR environment variable
174       that, when found, transforms a regular --partial option (such as
175       the convenient -P option) into one that also specifies a directory.
176
177     - Added --keep-dirlinks (-K), which allows you to symlink a directory
178       onto another partition on the receiving side and have rsync treat it
179       as matching a normal directory from the sender.
180
181     - Added the --inplace option that tells rsync to write each destination
182       file without using a temporary file.  The matching of existing data
183       in the destination file can be severely limited by this, but there
184       are also cases where this is more efficient (such as appending data).
185       Use only when needed (see the man page for more details).
186
187     - Added the "write only" option for the daemon's config file.
188
189     - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
190       and documented all these options in the man page.
191
192     - Improved the handling of the --bwlimit option so that it's less
193       bursty, more accurate, and works properly over a larger range of
194       values.
195
196     - The rsync daemon-over-ssh code now looks for SSH_CONNECTION and
197       SSH2_CLIENT in addition to SSH_CLIENT to figure out the IP address.
198
199     - Added the --checksum-seed=N option for advanced users.
200
201     - Batch writing/reading has a brand-new implementation that is simpler,
202       fixes a few weird problems with the old code (such as no longer
203       sprinkling the batch files into different dirs or even onto different
204       systems), and is much less intrusive into the code (making it easier
205       to maintain for the future).  The new code generates just one data
206       file instead of three, which makes it possible to read the batch on
207       stdin via a remote shell.  Also, the old requirement of forcing the
208       same fixed checksum-seed for all batch processing has been removed.
209
210     - If an rsync daemon has a module set with "list = no" (which hides its
211       presence in the list of available modules), a user that fails to
212       authenticate gets the same "unknown module" error that they would get
213       if the module were actually unknown (while still logging the real
214       error to the daemon's log file).  This prevents fishing for module
215       names.
216
217     - The daemon's "refuse options" config item now allows you to match
218       option names using wildcards and/or the single-letter option names.
219
220     - Each transferred file now gets its permissions and modified-time
221       updated before the temp-file gets moved into place.  Previously, the
222       finished file would have a very brief window where its permissions
223       disallowed all group and world access.
224
225     - Added the ability to parse a literal IPv6 address in an "rsync:" URL
226       (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
227
228     - The daemon's wildcard expanding code can now handle more than 1000
229       filenames (it's now limited by memory instead of having a hard-wired
230       limit).
231
232   INTERNAL:
233
234     - Some cleanup in the exclude code has saved some per-exclude memory
235       and made the code easier to maintain.
236
237     - Improved the argv-overflow checking for a remote command that has a
238       lot of args.
239
240     - Use rsyserr() in the various places that were still calling rprintf()
241       with strerror() as an arg.
242
243     - If an rsync daemon is listening on multiple sockets (to handle both
244       IPv4 and IPv6 to a single port), we now close all the unneeded file
245       handles after we accept a connection (we used to close just one of
246       them).
247
248     - Optimized the handling of larger block sizes (rsync used to slow to a
249       crawl if the block size got too large).
250
251     - Optimized away a loop in hash_search().
252
253     - Some improvements to the sanitize_path() and clean_fname() functions
254       makes them more efficient and produce better results (while still
255       being compatible with the file-name cleaning that gets done on both
256       sides when sending the file-list).
257
258     - Got rid of alloc_sanitize_path() after adding a destination-buffer
259       arg to sanitize_path() made it possible to put all the former's
260       functionality into the latter.
261
262     - The file-list that is output when at least 4 verbose options are
263       specified reports the uid value on the sender even when rsync is
264       not running as root (since we might be sending to a root receiver).
265
266   BUILD CHANGES:
267
268     - Added a "gen" target to rebuild most of the generated files,
269       including configure, config.h.in, the man pages, and proto.h.
270
271     - If "make proto" doesn't find some changes in the prototypes, the
272       proto.h file is left untouched (its time-stamp used to always be
273       updated).
274
275     - The variable $STRIP (that is optionally set by the install-strip
276       target's rule) was changed to $INSTALL_STRIP because some systems
277       have $STRIP already set in the environment.
278
279     - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
280
281     - When cross-compiling, the gettimeofday() function is now assumed to
282       be a modern version that takes two-args (since we can't test it).
283
284   DEVELOPER RELATED:
285
286     - The scripts in the testsuite dir were cleaned up a bit and a few
287       new tests added.
288
289     - Some new diffs were added to the patches dir, and some accepted
290       ones were removed.
291