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