Change man page src format from yodl to markdown.
[rsync.git] / NEWS.md
blob783064ab2b4b32b0365bc9f067873499e1cb92e3
1 # NEWS for rsync 3.2.0 (UNRELEASED)
3 Protocol: 31 (unchanged)
5 ## Changes since 3.1.3:
7 ### BUG FIXES:
9  - Avoid a potential out-of-bounds read in daemon mode if argc can be made to
10    become 0.
12  - Fix the default list of skip-compress files for non-daemon transfers.
14  - Fix xattr filter rules losing an 'x' attribute in a non-local transfer.
16  - Avoid an error when a check for a potential fuzzy file happens to reference
17    a directory.
19  - Make the atomic-rsync helper script have a more consistent error-exit.
21  - Make sure that a signal handler calls `_exit()` instead of exit().
23  - Various zlib fixes, including security fixes for CVE-2016-9843,
24    CVE-2016-9842, CVE-2016-9841, and CVE-2016-9840.
26  - Fixed an issue with `--remove-source-files` not removing a source symlink
27    when combined with `--copy-links`.
29  - Fixed a bug where the daemon would fail to write early fatal error messages
30    to the client, such as refused or unknown command-line options.
32  - Fixed the block-size validation logic when dealing with older protocols.
34  - Some rrsync fixes and enhancements to handle the latest options.
36  - Fixed a crash in the `--iconv` code.
38  - Fixed a problem with the `--link-dest`|`--copy-dest` code when `--xattrs`
39    was specified along with multiple alternate-destination directories (it
40    could possibly choose a bad file match while trying to find a better xattr
41    match).
43  - Fixed a couple bugs in the handling of files with the `--sparse` option.
45  - Fixed a bug in the writing of the batch.sh file (w/--write-batch) when the
46    source & destination args were not last on the command-line.
48  - Avoid a hang when an overabundance of messages clogs up all the I/O buffers.
50 ### ENHANCEMENTS:
52  - Various checksum enhancements, including the optional use of openssl's MD4 &
53    MD5 checksum algorithms, some x86-64 optimizations for the rolling checksum,
54    some x86-64 optimizations for the (non-openssl) MD5 checksum, the addition
55    of xxhash checksum support, and a negotiation heuristic that ensures that it
56    is easier to add new checksum algorithms in the future.  Currently the
57    x86-64 optimizations require the use of the `--enable-simd` flag to
58    configure, but they will probably be enabled by default in the near future.
59    The environment variable `RSYNC_CHECKSUM_LIST` can be used to customize the
60    preference order of the negotiation.
62  - Various compression enhancements, including the addition of zstd and lz4
63    compression algorithms and a negotiation heuristic that picks the best
64    compression option supported by both sides.  The environment variable
65    `RSYNC_COMPRESS_LIST` can be used to customize the preference order of the
66    heuristic when speaking to another rsync 3.2.0 version.
68  - Added a --debug=NSTR option that outputs details of the new negotiation
69    strings (for checksums and compression).  The first level just outputs the
70    result of each negotiation on the client, level 2 outputs the values of the
71    strings that were sent to and received from the server, and level 3 outputs
72    all those values on the server side too.
74  - The --debug=OPTS command-line option is no longer auto-forwarded to the
75    remote rsync which allows for the client and server to have different levels
76    of debug specified. This also allows for newer debug options to be
77    specified, such as using --debug=NSTR to see the negotiated hash result,
78    without having the command fail if the server version is too old to handle
79    that debug item. Use -M--debug=OPTS to send the options to the remote side.
81  - Added the `--atimes` option based on the long-standing patch (just with some
82    fixes that the patch has been needing).
84  - Added `--open-noatime` option to open files using `O_NOATIME`.
86  - Added the `--write-devices` option based on the long-standing patch.
88  - Added openssl support to the rsync-ssl script via a (lib installed) helper
89    script, ssl-rsh.  Both bash scripts are now installed by default, removing
90    the install-ssl-client make target.  Rsync was also enhanced to set the
91    `RSYNC_PORT` environment variable when running a daemon-over-rsh script. Its
92    value is the user-specified port number (set via `--port` or an rsync://
93    URL) or 0 if the user didn't override the port.
95  - Added negated matching to the daemon's `refuse options` setting by using
96    match strings that start with a `!` (such as `!compress*`).
98  - Added status output in response to a signal (via both SIGINFO & SIGVTALRM).
100  - Added a `--copy-as=USER` option to give some extra security to root-run
101    rsync commands into/from untrusted directories (such as backups and
102    restores).
104  - When resuming the transfer of a file in the `--partial-dir`, rsync will now
105    update that partial file in-place instead of creating yet another tmp file
106    copy.  This requires both sender & receiver to be at least v3.2.0.
108  - Added support for `RSYNC_SHELL` & `RSYNC_NO_XFER_EXEC` environment variables
109    that affect the pre-xfer exec and post-xfer exec rsync daemon options.
111  - Optimize the `--fuzzy` `--fuzzy` heuristic to avoid the fuzzy directory scan
112    until all other basis-file options are exhausted (such as `--link-dest`).
114  - Have a daemon that is logging include the normal-exit sent/received stats
115    even when the transfer exited with an error.
117  - The daemon now locks its pid file (when configured to use one) so that it
118    will not fail to start when the file exists and it is unlocked.
120  - Various man page improvements.
122  - Made -V the short option for --version.
124 ### DEVELOPER RELATED:
126  - Silenced some annoying warnings about major()|minor() due to the autoconf
127    include-file check not being smart enough.
129  - Improved some configure checks to work better with strict C99 compilers.
131  - The `--debug=FOO` options are no longer auto-forwarded to the server side,
132    allowing more control over what is output & the ability to request debug
133    data from divergent rsync versions.
135  - Some perl scripts were recoded into awk and python3.
137  - Some defines in byteorder.h were changed into static inline functions that
138    will help to ensure that the args don't get evaluated multiple times on
139    `careful alignment` hosts.
141  - Some code typos were fixed (as pointed out by a Fossies run).
143 ------------------------------------------------------------------------------