Changed showchg() into itemize(), which now ships off a flag byte of
[rsync/rsync.git] / NEWS
1 NEWS for rsync 2.6.4 (UNRELEASED)
2 Protocol: 29 (changed)
3 Changes since 2.6.3:
4
5   OUTPUT CHANGES:
6
7     - When rsync deletes a directory and outputs a verbose message about
8       it, it now appends a trailing slash to the name instead of (only
9       sometimes) outputting a preceding "directory " string.
10
11     - The --stats output will contain file-list time-statistics if both
12       sides are 2.6.4, or if the local side is 2.6.4 and the files are
13       being pushed (since the stats come from the sending side).
14       (Requires protocol 29.)
15   
16   BUG FIXES:
17
18     - Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
19       was only treating it as a special token in an rsync include/exclude
20       file).
21
22     - The combination of --verbose and --dry-run now mentions changes in
23       directories and it now includes the full update information that
24       would be output without --dry-run at higher levels of verbosity.
25
26     - Avoid a mkdir warning when removing a directory in the destination
27       that already exists in the --backup-dir.
28
29     - An OS that has a binary mode for its files (such as cygwin0 needed
30       setmode(fd, O_BINARY) called on the temp-file we opened with
31       mkstemp().  (Fix derived from the cygwin's rsync package.)
32
33     - Fixed a potential hang when verbosity is high, the client side is
34       the sender, and the file-list is large.
35
36     - We now check if the OS doesn't support using mknod() for creating
37       FIFOs and sockets, and compile-in using mkfifo() and socket() when
38       necessary.
39
40     - Fixed an off-by-one error in the handling of --max-delete=N.
41
42     - One place in the code wasn't checking if fork() failed.
43
44     - The "ignore nonreadable" daemon parameter no longer affects symlinks
45       that are being copied, even if they point nowhere.
46
47     - If the OS does not have lchown() and its chown() tries to set the
48       referent of a symlink (as it should), we no longer try to set the
49       user and group of a symlink.
50
51     - The generator now properly runs the hard-link loop and the dir-time
52       rewriting loop after we're sure that the redo phase is complete.
53
54     - When --backup was specified with --partial-dir=DIR (where DIR is a
55       relative path), the backup code was erroneously trying to backup a
56       file that was put into the partial-dir.
57
58     - One call to flush_write_file() was not being checked for an error.
59
60     - The --no-relative option was not being sent from the client to a
61       server sender.
62
63     - If an rsync daemon specified "dont compress = ..." for a file and the
64       client tried to specify --compress, the libz code was not handling a
65       compression level of 0 properly.  This could cause a transfer failure
66       if the block-size for a file was large enough (i.e. rsync might have
67       exited with an error for large files).
68
69     - If a daemon can't open the specified log file (i.e. syslog is not
70       being used), die without crashing.  We also try to output an error
71       about the failure (which will only be seen if --no-detach was
72       specified).
73
74     - A local transfer no longer duplicates all its include/exclude options
75       by sending the forked process a copy of the list it already has.
76
77   ENHANCEMENTS:
78
79     - Rsync now supports popt's option aliases, which means that you can
80       use /etc/popt and/or ~/.popt to create your own option aliases.
81
82     - Added the --delete-during (--del) option which will delete files
83       from on the receiving side incrementally as each directory in the
84       transfer is being processed (which makes it more efficient than the
85       default, before-the-transfer behavior of --delete).  Note that the
86       --del option is implemented as an internally-defined popt alias, so
87       an rsync daemon that refuses "delete" (which, for safety's sake,
88       really matches "delete*") will still refuse all delete options.  The
89       default --delete behavior is also explicitly selectable via
90       --delete-before.
91
92     - All the --delete-WHEN options are now more memory efficient:
93       Previously an entire duplicate set of file-list objects was created
94       on the receiving side for the entire destination hierarchy.  The new
95       algorithm only creates one directory of objects at a time.
96
97     - Added the --copy-dest option, which works like --link-dest except
98       that it includes copies of identical files.
99
100     - Added support for specifying multiple --compare-dest, --copy-dest, or
101       --link-dest options, but only of a single type. (Promoted from the
102       patches dir and enhanced.)
103
104     - Added the --max-size option. (Promoted from the patches dir.)
105
106     - The daemon-mode options were separated from the normal rsync options
107       so that they can't be mixed together.  This makes it impossible to
108       start a daemon that had improper default option values that could
109       cause problems (such as a hang or an abort) when a client connects.
110
111     - The --bwlimit option may now be used in combination with --daemon
112       to specify both a default value for the daemon side and a value
113       that cannot be exceeded by a user-specified --bwlimit option.
114
115     - Added the "port" parameter to the rsyncd.conf file. (Promoted from
116       the patches dir.)  Also added "address".  A command-line option
117       will take precedence over a config-file option, as expected.
118
119     - In _exit_cleanup(): when we are exiting with a partially-received
120       file, we now flush any data in the write-cache before closing the
121       partial file.
122
123     - The --inplace support was enhanced to work with --compare-dest,
124       --link-dest, and (the new) --copy-dest options. (Requires protocol
125       29.)
126
127     - Added the --dirs (-d) option for an easier way to copy directories
128       without recursion.
129
130     - Added the --list-only option which is mainly a way for the client to
131       put the server into listing mode without needing to resort to any
132       option kluges (e.g. the age-old use of "-r --exclude="/*/*" for a
133       non-recursive listing).  This option is used automatically when a
134       modern rsync speaks to a modern daemon, but may also be specified
135       manually if you want to force the use of the --list-only option over
136       a remote-shell connection.
137
138     - Added the --omit-dir-times (-O) option which will avoid updating the
139       modified time for directories when --times was specified.  This
140       option will avoid an extra pass through the file-list at the end of
141       the transfer (to tweak all the directory times), which can result in
142       an appreciable speedup for a really large transfer. (Promoted from
143       the patches dir.)
144
145     - Added the --filter (-f) option and its helper option, -F.  Filter
146       rules are an extension to the existing include/exclude handling
147       that also supports nested filter files as well as per-directory
148       filter files (like .cvsignore, but with full filter-rule parsing).
149       This new option was chosen in order to ensure that all existing
150       include/exclude processing remained 100% compatible with older
151       versions.  Protocol 29 is needed for full filter-rule support, but
152       backward-compatible rules work with earlier protocol versions.
153       (Promoted from the patches dir.)
154
155     - Added the --delay-updates option that puts all updated files into
156       a temporary directory (by default ".~tmp~", but settable via the
157       --partial-dir=DIR option) until the end of the transfer.  This
158       makes the updates a little more atomic for a large transfer.
159
160     - If rsync is put into the background, any output from --progress is
161       reduced.
162
163     - Documented the "max verbosity" setting for rsyncd.conf.  (This
164       setting was added a couple releases ago, but left undocumented.)
165
166     - The sender and the generator now double-check the file-list index
167       they are given, and refuse to operate on a directory index (since
168       that would indicate that something had gone very wrong).
169
170     - Added the --itemize-changes (-i) option that is a way to output the
171       list of files that got transferred and/or changed in any way, and how
172       they changed.  Also works with --dry-run.
173
174     - Added the --fuzzy option, which attempts to find a basis file for a
175       file that is being created from scratch.  The current algorithm
176       only looks in the destination directory for the created file, but
177       it does attempt to find a match based on size/mod-time (in case the
178       file was renamed with no other changes) as well as based on a fuzzy
179       name-matching algorithm.  This option requires protocol 29 because
180       it needs the new file-sorting order.  (Promoted from patches dir
181       and enhanced.)
182
183   SUPPORT FILES:
184
185     - Added support/atomic-rsync -- a perl script that will transfer some
186       files using rsync, and then move the updated files into place all at
187       once at the end of the transfer.  Only works when pulling, and uses
188       --link-dest and a parallel hierarchy of files to effect its update.
189
190     - Added support/mnt-excl that takes the /proc/mounts file and
191       translates it into a set of excludes that will exclude all mount
192       points (even mapped mounts to the same disk).  The excludes are made
193       relative to the specified source dir and properly anchored.
194
195     - Added support/savetransfer.c -- a C program that can make a copy of
196       all the data that flows over the wire.  This lets you test for data
197       corruption (by saving the data on both the sending side and the
198       receiving side) or provides a way to help debug a protocol error.
199
200     - Added support/rrsync -- my version of Joe Smith's restricted rsync
201       perl script.  This helps to ensure that only certain rsync commands
202       can be run by an ssh invocation.
203
204     - Improved the option descriptions in the --help text.
205
206   INTERNAL:
207
208     - Added better checking of the checksum-header values that come over
209       the socket.
210
211     - Merged the various delete-file functions into a single function so
212       that it is easier to maintain.
213
214     - Improved the type of some variables (particularly blocksize vars) for
215       consistency and proper size.
216
217     - Got rid of the uint64 type (which we didn't need).
218
219     - Use a slightly more compatible set of core #include directives.
220
221     - Defined int32 in a way that ensures that the build dies if we can't
222       find a variable with at least 32 bits.
223
224     - The daemon's "read only" config item now sets an internal read_only
225       variable that makes extra sure that no write/delete calls on the
226       read-only side can succeed.
227
228   PROTOCOL DIFFERENCES FOR VERSION 29:
229
230     - If --inplace is specified, the generator sends an extra byte after
231       each index integer indicating what kind of basis file is being used
232       for the transfer (see the FNAMECMP_* defines).
233
234     - The sending of exclude names is done using filter-rule syntax.  This
235       means that all names have a prefixed rule indicator, even excludes
236       (which used to be sent as a bare pattern, when possible).  The -C
237       option will include the per-dir .cvsignore merge file in the list of
238       filter rules so it is positioned correctly (unlike in some older
239       transfer scenarios).
240
241     - Rsync sorts the filename list in a different way:  it sorts the
242       subdir names after the non-subdir names for each dir's contents, and
243       it always puts a dir's contents immediately after the dir's name in
244       the list.  (Previously an item named "foo.txt" would sort in between
245       directory "foo/" and "foo/bar".)
246
247     - When talking to a protocol 29 rsync daemon, a list-only request
248       is able to note this before the options are sent over the wire, and
249       the new --list-only option is enabled.
250
251     - When the --stats bytes are sent over the wire (or stored in a batch),
252       they now include two elapsed-time values: one for how long it took to
253       build the file-list, and one for how long it took to send it over the
254       wire (each expressed in thousandths of a second).
255
256     - When --delete-excluded is specified with some filter rules (AKA
257       excludes), a client sender will still initiate a send of the filter
258       rules to the receiver, but it only includes those rules that are
259       receiver-specific.  Older protocols used to omit the sending of
260       excludes in this situation (since there were no receiver-specific
261       rules that survived --delete-excluded back then).
262
263     - A protocol-29 batch file includes a bit for the setting of the --dirs
264       option.  Also, the shell script created by --write-batch will use the
265       --filter option instead of --exclude-from to capture any filter rules.
266
267   BUILD CHANGES:
268
269     - Handle an operating system that use mkdev() in place of makedev().
270
271     - Improved configure to better handle cross-compiling.