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