More improvements and a couple missing items.
[rsync/rsync.git] / NEWS
1 NEWS for rsync 2.6.3 (UNRELEASED)
2 Protocol: 28 (unchanged)
3 Changes since 2.6.2:
4
5   OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
6
7     - Please note that the 2-line footer (output when verbose) now uses the
8       term "sent" instead of "wrote" and "received" instead of "read".  If
9       you are not parsing the numeric values out of this footer, a script
10       would be better off using the empty line prior to the footer as the
11       indicator that the verbose output is over.
12       
13     - The output from the --stats option was similarly affected to change
14       "written" to "sent" and "read" to "received".
15
16     - Rsync ensures that a filename that contains a newline gets mentioned
17       with each newline transformed into a question mark (which prevents a
18       filename from causing an empty line to be output).
19
20   BUG FIXES:
21
22     - Fixed a crash bug that might appear when --delete was used and
23       multiple source directories were specified.
24
25     - Fixed the 32-bit truncation of the file length when generating the
26       checksums.
27
28     - The --backup code no longer attempts to create some directories
29       over and over again (generating warnings along the way).
30
31     - Fixed a bug in the reading of the secrets file (by the daemon) and
32       the password file (by the client):  the files no longer need to be
33       terminated by a newline for their content to be read in.
34
35     - If a file has a read error on the sending side or the reconstructed
36       data doesn't match the expected checksum (perhaps due to the basis
37       file changing during the transfer), the receiver will no longer
38       retain the resulting file unless the --partial option was specified.
39       (Note: for the read-error detection to work, neither side can be
40       older than 2.6.3 -- older receivers will always retain the file, and
41       older senders don't tell the receiver that the file had a read
42       error.)
43
44     - If a file gets resent in a single transfer and the --backup option
45       is enabled, rsync no longer performs a duplicate backup (it used to
46       overwrite the original file in the backup area).
47
48     - Files specified in the daemon's "exclude" or "exclude from" config
49       items are now excluded from being uploaded (assuming that the module
50       allows uploading at all) in addition to the old download exclusion.
51
52     - Got rid of a potential hang in the receiver when near the end of a
53       phase.
54
55     - When using --backup without a --backup-dir, rsync no longer preserves
56       the modify time on directories.  This avoids confusing NFS.
57
58     - When --copy-links (-L) is specified, we now output a separate error
59       for a symlink that has no referent instead of claiming that a file
60       "vanished".
61
62     - The --copy-links (-L) option no longer has the side-effect of telling
63       the receiving side to follow symlinks.  See the --keep-dirlinks
64       option (mentioned below) for a way to specify that behavior.
65
66     - Error messages from the daemon server's option-parsing (such as
67       refused options) now get sent back to the client (the server used
68       to just exit because the socket wasn't in the right state to send
69       the message).
70
71     - Most errors that occur during a daemon transfer are now returned to
72       the user in addition to being logged (some messages are intended to
73       be daemon-only).
74
75     - Fixed a bug in the daemon authentication code when using one of the
76       batch-processing options.
77
78     - We try to work around some buggy IPv6 implementations that fail to
79       implement IPV6_V6ONLY.  This should fix the "address in use" error
80       that some daemons get when running on an OS with a buggy IPv6
81       implementation.  Also, if the new code gets this error, we might
82       suggest that the user specify --ipv4 or --ipv6 (if we think it will
83       help).
84
85     - When the remote rsync dies, make a better effort to recover any error
86       messages it may have sent before dying (the local rsync used to just
87       die with a socket-write error).
88
89     - When using --delete and a --backup-dir that contains files that are
90       hard-linked to their destination equivalents, rsync now makes sure
91       that removed files really get removed (works around a really weird
92       rename() behavior).
93
94     - Avoid a bogus run-time complaint about a lack of 64-bit integers when
95       the int64 type is defined as an off_t and it actually has 64-bits.
96
97     - Added a configure check for open64() without mkstemp64() so that we
98       can avoid using mkstemp() when such a combination is encountered.
99       This bypasses a problem writing out large temp files on OSes such as
100       AIX and HP-UX.
101
102     - Fixed an age-old crash problem with --read-batch on a local copy
103       (rsync was improperly assuming --whole-file for the local copy).
104
105     - When --dry-run (-n) is used and the destination directory does not
106       exist, rsync now produces a correct report of files that would be
107       sent instead of dying with a chdir() error.
108
109   ENHANCEMENTS:
110
111     - Added the --partial-dir=DIR option that lets you specify where to
112       (temporarily) put a partially transferred file (instead of over-
113       writing the destination file).  E.g.  --partial-dir=.rsync-partial
114
115     - Added --keep-dirlinks (-K), which allows you to symlink a directory
116       onto another partition on the receiving side and have rsync treat it
117       as matching a normal directory from the sender.
118
119     - Added the --inplace option that tells rsync to write each destination
120       file without using a temporary file.  The matching of existing data
121       in the destination file can be severely limited by this, but there
122       are also cases where this is more efficient (such as appending data).
123       Use only when needed (see the man page for more details).
124
125     - Added the "write only" option for the daemon's config file.
126
127     - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
128       and documented all these options in the man page.
129
130     - Improved the handling of the --bwlimit option so that it's less
131       bursty, more accurate, and works properly over a larger range of
132       values.
133
134     - The rsync daemon-over-ssh code now looks for SSH_CONNECTION and
135       SSH2_CLIENT in addition to SSH_CLIENT to figure out the IP address.
136
137     - Added the --checksum-seed=N option for advanced users.
138
139     - Batch writing/reading has a brand-new implementation that is simpler,
140       fixes a few weird problems with the old code (such as no longer
141       sprinkling the batch files into different dirs or even onto different
142       systems), and is much less intrusive into the code (making it easier
143       to maintain for the future).  The new code generates just one data
144       file instead of three, which makes it possible to read the batch via
145       stdin over a remote shell.  Also, the old requirement of forcing the
146       same fixed checksum-seed for all batch processing has been removed.
147
148     - If an rsync daemon has a module set with "list = no" (which hides its
149       presence in the list of available modules), a user that fails to
150       authenticate gets the same "unknown module" error that they would get
151       if the module were actually unknown (while still logging the real
152       error to the daemon's log file).  This prevents fishing for module
153       names.
154
155     - The daemon's "refuse options" config item now allows you to match
156       option names using wildcards and/or the single-letter option names.
157
158     - The finished file now gets its permissions and modified-time updated
159       before it gets moved into place.
160
161     - Lots of documentation improvements in the exclude/include sections.
162
163   INTERNAL:
164
165     - Some cleanup in the exclude code has saved some per-exclude memory
166       and made the code easier to maintain.
167
168     - Improved the argv-overflow checking for a remote command that has a
169       lot of args.
170
171     - Use rsyserr() in the various places that were still calling rprintf()
172       with strerror() as an arg.
173
174     - If an rsync daemon is listening on multiple sockets (to handle both
175       IPv4 and IPv6 to a single port), we now close all the unneeded file
176       handles after we accept a connection (we used to close just one of
177       them).
178
179     - Optimized the handling of larger block sizes (rsync used to slow to a
180       crawl if the block size got too large).
181
182     - Optimized away a loop in hash_search().
183
184     - Some improvements to the sanitize_path() and clean_fname() functions
185       makes them more efficient and produce better results (while still
186       being compatible with the file-name cleaning that gets done on both
187       sides when sending the file-list).
188
189     - Got rid of alloc_sanitize_path() after adding a destination-buffer
190       arg to sanitize_path() made it possible to put all the former's
191       functionality into the latter.
192
193   BUILD CHANGES:
194
195     - Added a "gen" target to rebuild most of the generated files,
196       including configure, config.h.in, the man pages, and proto.h.
197
198     - If "make proto" doesn't find some changes in the prototypes, the
199       proto.h file is left untouched (its time-stamp used to always be
200       updated).
201
202     - The variable $STRIP (that is optionally set by the install-strip
203       target's rule) was changed to $INSTALL_STRIP because some systems
204       have $STRIP set in the environment.
205
206     - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
207
208   DEVELOPER RELATED:
209
210     - The scripts in the testsuite dir were cleaned up a bit and a few
211       new tests added.
212
213     - Some new diffs were added to the patches dir, and some accepted
214       ones were removed.
215