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